Nordic stack and drivers for the mbed BLE API Modified for HRM1017 for library 0.1.0
Fork of nRF51822 by
softdevice_handler.h
00001 /* Copyright (c) 2013 Nordic Semiconductor. All Rights Reserved. 00002 * 00003 * The information contained herein is property of Nordic Semiconductor ASA. 00004 * Terms and conditions of usage are described in detail in NORDIC 00005 * SEMICONDUCTOR STANDARD SOFTWARE LICENSE AGREEMENT. 00006 * 00007 * Licensees are granted free, non-transferable use of the information. NO 00008 * WARRANTY of ANY KIND is provided. This heading must NOT be removed from 00009 * the file. 00010 * 00011 */ 00012 00013 /** @file 00014 * 00015 * @defgroup softdevice_handler SoftDevice Event Handler 00016 * @{ 00017 * @ingroup app_common 00018 * @brief API for initializing and disabling the SoftDevice 00019 * 00020 * @details This API contains the functions and defines exposed by the @ref lib_softdevice_handler. 00021 * For more information on the library and how the application should use it, please refer 00022 * @ref lib_softdevice_handler. 00023 * 00024 * @note Use the USE_SCHEDULER parameter of the SOFTDEVICE_HANDLER_INIT() macro to select if 00025 * the @ref app_scheduler is to be used or not. 00026 * 00027 * @note Even if the scheduler is not used, softdevice_handler.h will include app_scheduler.h. 00028 * So when compiling, app_scheduler.h must be available in one of the compiler include 00029 * paths. 00030 */ 00031 00032 #ifndef SOFTDEVICE_HANDLER_H__ 00033 #define SOFTDEVICE_HANDLER_H__ 00034 00035 #include <stdlib.h> 00036 #include "nordic_common.h" 00037 #include "nrf_sdm.h" 00038 #include "app_error.h " 00039 #include "app_scheduler.h " 00040 #include "app_util.h " 00041 #include "ble_stack_handler_types.h " 00042 #include "ant_stack_handler_types.h " 00043 00044 #ifdef __cplusplus 00045 extern "C" { 00046 #endif // #ifdef __cplusplus 00047 00048 #define SOFTDEVICE_SCHED_EVT_SIZE 0 /**< Size of button events being passed through the scheduler (is to be used for computing the maximum size of scheduler events). For SoftDevice events, this size is 0, since the events are being pulled in the event handler. */ 00049 #define SYS_EVT_MSG_BUF_SIZE sizeof(uint32_t) /**< Size of System (SOC) event message buffer. */ 00050 00051 /**@brief Type of function for passing events from the stack handler module to the scheduler. */ 00052 typedef uint32_t (*softdevice_evt_schedule_func_t) (void); 00053 00054 /**@brief Application System (SOC) event handler type. */ 00055 typedef void (*sys_evt_handler_t) (uint32_t evt_id); 00056 00057 00058 /**@brief Macro for initializing the stack event handler. 00059 * 00060 * @details It will handle dimensioning and allocation of the memory buffer required for reading 00061 * events from the stack, making sure the buffer is correctly aligned. It will also 00062 * connect the stack event handler to the scheduler (if specified). 00063 * 00064 * @param[in] CLOCK_SOURCE Low frequency clock source and accuracy (type nrf_clock_lfclksrc_t, 00065 * see sd_softdevice_enable() for details). 00066 * @param[in] USE_SCHEDULER TRUE if the application is using the event scheduler, FALSE 00067 * otherwise. 00068 * 00069 * @note Since this macro allocates a buffer, it must only be called once (it is OK to call it 00070 * several times as long as it is from the same location, that is to do a 00071 * reinitialization). 00072 */ 00073 /*lint -emacro(506, SOFTDEVICE_HANDLER_INIT) */ /* Suppress "Constant value Boolean */ 00074 #define SOFTDEVICE_HANDLER_INIT(CLOCK_SOURCE, USE_SCHEDULER) \ 00075 do \ 00076 { \ 00077 static uint32_t EVT_BUFFER[CEIL_DIV(MAX(MAX(BLE_STACK_EVT_MSG_BUF_SIZE, ANT_STACK_EVT_STRUCT_SIZE), SYS_EVT_MSG_BUF_SIZE), sizeof(uint32_t))]; \ 00078 uint32_t ERR_CODE; \ 00079 ERR_CODE = softdevice_handler_init((CLOCK_SOURCE), EVT_BUFFER, sizeof(EVT_BUFFER), (USE_SCHEDULER) ? softdevice_evt_schedule : NULL); \ 00080 APP_ERROR_CHECK(ERR_CODE); \ 00081 } while (0) 00082 00083 00084 /**@brief Function for initializing the stack handler module. 00085 * 00086 * @details Enables the SoftDevice and the stack event interrupt handler. 00087 * 00088 * @note This function must be called before calling any function in the SoftDevice API. 00089 * 00090 * @note Normally initialization should be done using the SOFTDEVICE_HANDLER_INIT() macro, 00091 * as that will both allocate the event buffer, and also align the buffer correctly. 00092 * 00093 * @param[in] clock_source Low frequency clock source to be used by the SoftDevice. 00094 * @param[in] p_evt_buffer Buffer for holding one stack event. Since heap is not being 00095 * used, this buffer must be provided by the application. The 00096 * buffer must be large enough to hold the biggest stack event the 00097 * application is supposed to handle. The buffer must be aligned to 00098 * a 4 byte boundary. This parameter is unused if neither BLE nor 00099 * ANT stack support is required. 00100 * @param[in] evt_buffer_size Size of SoftDevice event buffer. This parameter is unused if 00101 * BLE stack support is not required. 00102 * @param[in] evt_schedule_func Function for passing events to the scheduler. Point to 00103 * ble_ant_stack_evt_schedule() to connect to the scheduler. 00104 * Set to NULL to make the stack handler module call the event 00105 * handler directly from the stack event interrupt handler. 00106 * 00107 * @retval NRF_SUCCESS Successful initialization. 00108 * @retval NRF_ERROR_INVALID_PARAM Invalid parameter (buffer not aligned to a 4 byte 00109 * boundary) or NULL. 00110 */ 00111 uint32_t softdevice_handler_init(nrf_clock_lfclksrc_t clock_source, 00112 void * p_evt_buffer, 00113 uint16_t evt_buffer_size, 00114 softdevice_evt_schedule_func_t evt_schedule_func); 00115 00116 00117 /**@brief Function for disabling the SoftDevice. 00118 * 00119 * @details This function will disable the SoftDevice. It will also update the internal state 00120 * of this module. 00121 */ 00122 uint32_t softdevice_handler_sd_disable(void); 00123 00124 00125 /**@brief Function for registering for System (SOC) events. 00126 * 00127 * @details The application should use this function to register for receiving System (SOC) 00128 * events from the SoftDevice. If the application does not call this function, then any 00129 * System (SOC) events that may be generated by the SoftDevice will NOT be fetched. Once 00130 * the application has registered for the events, it is not possible to possible to 00131 * cancel the registration. However, it is possible to register a different function for 00132 * handling the events at any point of time. 00133 * 00134 * @param[in] sys_evt_handler Function to be called for each received System (SOC) event. 00135 * 00136 * @retval NRF_SUCCESS Successful registration. 00137 * @retval NRF_ERROR_NULL Null pointer provided as input. 00138 */ 00139 uint32_t softdevice_sys_evt_handler_set(sys_evt_handler_t sys_evt_handler); 00140 00141 00142 // Functions for connecting the Stack Event Handler to the scheduler: 00143 /**@cond NO_DOXYGEN */ 00144 void intern_softdevice_events_execute(void); 00145 00146 static __INLINE void softdevice_evt_get(void * p_event_data, uint16_t event_size) 00147 { 00148 APP_ERROR_CHECK_BOOL(event_size == 0); 00149 intern_softdevice_events_execute(); 00150 } 00151 00152 static __INLINE uint32_t softdevice_evt_schedule(void) 00153 { 00154 return app_sched_event_put(NULL, 0, softdevice_evt_get); 00155 } 00156 /**@endcond */ 00157 00158 #ifdef __cplusplus 00159 } 00160 #endif // #ifdef __cplusplus 00161 00162 #endif // SOFTDEVICE_HANDLER_H__ 00163 00164 /** @} */
Generated on Tue Jul 12 2022 14:11:57 by 1.7.2