owner-nrf52sdk/nRF5_SDK_15.3.0/components/iot/background_dfu/background_dfu_operation.h

/**
 * Copyright (c) 2017 - 2019, Nordic Semiconductor ASA
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form, except as embedded into a Nordic
 *    Semiconductor ASA integrated circuit in a product or a software update for
 *    such product, must reproduce the above copyright notice, this list of
 *    conditions and the following disclaimer in the documentation and/or other
 *    materials provided with the distribution.
 *
 * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
 *    contributors may be used to endorse or promote products derived from this
 *    software without specific prior written permission.
 *
 * 4. This software, with or without modification, must only be used with a
 *    Nordic Semiconductor ASA integrated circuit.
 *
 * 5. Any software provided in binary form under this license must not be reverse
 *    engineered, decompiled, modified and/or disassembled.
 *
 * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

/** @file
 *
 * @defgroup background_dfu_operation background_dfu_operation.h
 * @{
 * @ingroup background_dfu
 * @brief Background DFU operations.
 *
 */

#ifndef BACKGROUND_DFU_OPERATION_H_
#define BACKGROUND_DFU_OPERATION_H_

#include <stdint.h>

#include "nrf_dfu_handling_error.h"

/** @brief Function for selecting a DFU object.
 *
 *  @param[in]  object_type  Object type which should be selected.
 *  @param[in]  callback     Callback function to be executed after the operation is completed.
 *  @param[in]  p_context    Pointer to the operation context.
 *
 *  @return Operation result code.
 */
ret_code_t background_dfu_op_select(uint32_t                    object_type,
                                    nrf_dfu_response_callback_t callback,
                                    void                      * p_context);

/** @brief Create DFU object.
 *
 *  @param[in]  object_type  Object type which should be selected.
 *  @param[in]  object_size  Size of the object to create.
 *  @param[in]  callback     Callback function to be executed after the operation is completed.
 *  @param[in]  p_context    Pointer to the operation context.
 *
 *  @return Operation result code.
 */
ret_code_t background_dfu_op_create(uint32_t                    object_type,
                                    uint32_t                    object_size,
                                    nrf_dfu_response_callback_t callback,
                                    void                      * p_context);

/** @brief Function for writing a DFU object.
 *
 *  @param[in]  p_payload          Pointer to data which should be written to the object.
 *  @param[in]  payload_length     Length, in bytes, of data which should be written to the object.
 *  @param[in]  response_callback  Callback function to be executed after the operation is scheduled.
 *  @param[in]  write_callback     Callback function to be executed after the operation is finished.
 *  @param[in]  p_context          Pointer to the operation context.
 *
 *  @return Operation result code.
 */
ret_code_t background_dfu_op_write(const uint8_t             * p_payload,
                                   uint16_t                    payload_length,
                                   nrf_dfu_response_callback_t response_callback,
                                   nrf_dfu_flash_callback_t    write_callback,
                                   void                      * p_context);

/** @brief Function for calculating a DFU object CRC.
 *
 *  @param[in]  callback     Callback function to be executed after the operation is completed.
 *  @param[in]  p_context    Pointer to the operation context.
 *
 *  @return Operation result code.
 */
ret_code_t background_dfu_op_crc(nrf_dfu_response_callback_t callback,
                                 void                      * p_context);

/** @brief Function for executing the selected DFU.
 *
 *  @param[in]  callback     Callback function to be executed after the operation is completed.
 *  @param[in]  p_context    Pointer to the operation context.
 *
 *  @return Operation result code.
 */
ret_code_t background_dfu_op_execute(nrf_dfu_response_callback_t callback,
                                     void                      * p_context);

#endif /* BACKGROUND_DFU_OPERATION_H_ */