dfu_ble_svc_internal.h

00001 /*
00002  * Copyright (c) Nordic Semiconductor ASA
00003  * All rights reserved.
00004  *
00005  * Redistribution and use in source and binary forms, with or without modification,
00006  * are permitted provided that the following conditions are met:
00007  *
00008  *   1. Redistributions of source code must retain the above copyright notice, this
00009  *   list of conditions and the following disclaimer.
00010  *
00011  *   2. Redistributions in binary form must reproduce the above copyright notice, this
00012  *   list of conditions and the following disclaimer in the documentation and/or
00013  *   other materials provided with the distribution.
00014  *
00015  *   3. Neither the name of Nordic Semiconductor ASA nor the names of other
00016  *   contributors to this software may be used to endorse or promote products
00017  *   derived from this software without specific prior written permission.
00018  *
00019  *
00020  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
00021  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
00022  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00023  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
00024  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
00025  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00026  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
00027  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00028  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00029  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00030  *
00031  */
00032   
00033 /** @file
00034  *
00035  * @defgroup nrf_dfu_ble_svc_internal DFU BLE SVC internal
00036  * @{
00037  *
00038  * @brief DFU BLE SVC internal functions in bootloader. The DFU BLE SuperVisor Calls allow an 
00039  *        application to execute functions in the installed bootloader. This interface provides 
00040  *        internal Bootloader DFU functions for retrieving data exchanged through SuperVisor Calls.
00041  *
00042  */
00043 
00044 #ifndef DFU_BLE_SVC_INTERNAL_H__
00045 #define DFU_BLE_SVC_INTERNAL_H__
00046 
00047 #include <stdint.h>
00048 #include "dfu_ble_svc.h "
00049 #include "ble_gap.h"
00050 
00051 /**@brief Internal bootloader/DFU function for retrieving peer data provided from application.
00052  *
00053  * @param[out] p_peer_data Peer data set by application to be used for DFU connection.
00054  *
00055  * @retval NRF_SUCCESS            If peer data is valid and can be used for connection.
00056  * @retval NRF_ERROR_NULL         If p_peer_data is a NULL pointer.
00057  * @retval NRF_ERROR_INVALID_DATA If peer data is not available or invalid.
00058  */
00059 uint32_t dfu_ble_peer_data_get(dfu_ble_peer_data_t * p_peer_data);
00060 
00061 #endif // DFU_BLE_SVC_INTERNAL_H__
00062 
00063 /** @} */