Rob Kluin / nRF51822

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of nRF51822 by Nordic Semiconductor

nordic-sdk/components/libraries/scheduler/app_scheduler.c@361:d2405f5a4853, 2015-07-02 (annotated)

Committer:
rgrover1
Date:
Thu Jul 02 09:08:44 2015 +0100
Revision:
361:d2405f5a4853
Parent:
346:14b090482fd2
Child:
362:6fa0d4d555f6
Synchronized with git rev 9f72c4ba

Author: Rohit Grover

Release 0.3.7

=============



This is a minor set of enhancements mostly around reduce our global static

memory footprint.



Enhancements

~~~~~~~~~~~~



* Reduce the maximum number of CHARACTERISTICS and DESCRIPTORS that can be

  handled. This has memory implications for static global memory. It should

  be possible to re-architect our solution for add_characteristic() to not

  require these limits; hopefully we'll get there soon.



* Move nRF51GattServer::getInstance() into a .cpp file; same for nRF51Gap::getInstance().



* Reduce max bonds to managed by device-manager to 4; this has memory implications for static global memory.



* Reduce pStorage command queue size to 2; this has memory implications for static global memory.



* Replace uses of deprecated Gap::addr_type_t with Gap::AddressType_t.



* Some UUID-related types have moved into UUID class. Minor changes were needed to work around build errors.



Bugfixes

~~~~~~~~



* None.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 361:d2405f5a4853 1 /* Copyright (c) 2012 Nordic Semiconductor. All Rights Reserved.
rgrover1 361:d2405f5a4853 2 *
rgrover1 361:d2405f5a4853 3 * The information contained herein is property of Nordic Semiconductor ASA.
rgrover1 361:d2405f5a4853 4 * Terms and conditions of usage are described in detail in NORDIC
rgrover1 361:d2405f5a4853 5 * SEMICONDUCTOR STANDARD SOFTWARE LICENSE AGREEMENT.
rgrover1 361:d2405f5a4853 6 *
rgrover1 361:d2405f5a4853 7 * Licensees are granted free, non-transferable use of the information. NO
rgrover1 361:d2405f5a4853 8 * WARRANTY of ANY KIND is provided. This heading must NOT be removed from
rgrover1 361:d2405f5a4853 9 * the file.
rgrover1 361:d2405f5a4853 10 *
rgrover1 361:d2405f5a4853 11 */
rgrover1 361:d2405f5a4853 12
rgrover1 361:d2405f5a4853 13 #include "app_scheduler.h"
rgrover1 361:d2405f5a4853 14 #include <stdlib.h>
rgrover1 361:d2405f5a4853 15 #include <stdint.h>
rgrover1 361:d2405f5a4853 16 #include <string.h>
rgrover1 361:d2405f5a4853 17 #include "nrf_soc.h"
rgrover1 361:d2405f5a4853 18 #include "nrf_assert.h"
rgrover1 361:d2405f5a4853 19 #include "app_util.h"
rgrover1 361:d2405f5a4853 20 #include "app_util_platform.h"
rgrover1 361:d2405f5a4853 21
rgrover1 361:d2405f5a4853 22 /**@brief Structure for holding a scheduled event header. */
rgrover1 361:d2405f5a4853 23 typedef struct
rgrover1 361:d2405f5a4853 24 {
rgrover1 361:d2405f5a4853 25 app_sched_event_handler_t handler; /**< Pointer to event handler to receive the event. */
rgrover1 361:d2405f5a4853 26 uint16_t event_data_size; /**< Size of event data. */
rgrover1 361:d2405f5a4853 27 } event_header_t;
rgrover1 361:d2405f5a4853 28
rgrover1 361:d2405f5a4853 29 STATIC_ASSERT(sizeof(event_header_t) <= APP_SCHED_EVENT_HEADER_SIZE);
rgrover1 361:d2405f5a4853 30
rgrover1 361:d2405f5a4853 31 static event_header_t * m_queue_event_headers; /**< Array for holding the queue event headers. */
rgrover1 361:d2405f5a4853 32 static uint8_t * m_queue_event_data; /**< Array for holding the queue event data. */
rgrover1 361:d2405f5a4853 33 static volatile uint8_t m_queue_start_index; /**< Index of queue entry at the start of the queue. */
rgrover1 361:d2405f5a4853 34 static volatile uint8_t m_queue_end_index; /**< Index of queue entry at the end of the queue. */
rgrover1 361:d2405f5a4853 35 static uint16_t m_queue_event_size; /**< Maximum event size in queue. */
rgrover1 361:d2405f5a4853 36 static uint16_t m_queue_size; /**< Number of queue entries. */
rgrover1 361:d2405f5a4853 37
rgrover1 361:d2405f5a4853 38 /**@brief Function for incrementing a queue index, and handle wrap-around.
rgrover1 361:d2405f5a4853 39 *
rgrover1 361:d2405f5a4853 40 * @param[in] index Old index.
rgrover1 361:d2405f5a4853 41 *
rgrover1 361:d2405f5a4853 42 * @return New (incremented) index.
rgrover1 361:d2405f5a4853 43 */
rgrover1 361:d2405f5a4853 44 static __INLINE uint8_t next_index(uint8_t index)
rgrover1 361:d2405f5a4853 45 {
rgrover1 361:d2405f5a4853 46 return (index < m_queue_size) ? (index + 1) : 0;
rgrover1 361:d2405f5a4853 47 }
rgrover1 361:d2405f5a4853 48
rgrover1 361:d2405f5a4853 49
rgrover1 361:d2405f5a4853 50 static __INLINE uint8_t app_sched_queue_full()
rgrover1 361:d2405f5a4853 51 {
rgrover1 361:d2405f5a4853 52 uint8_t tmp = m_queue_start_index;
rgrover1 361:d2405f5a4853 53 return next_index(m_queue_end_index) == tmp;
rgrover1 361:d2405f5a4853 54 }
rgrover1 361:d2405f5a4853 55
rgrover1 361:d2405f5a4853 56 /**@brief Macro for checking if a queue is full. */
rgrover1 361:d2405f5a4853 57 #define APP_SCHED_QUEUE_FULL() app_sched_queue_full()
rgrover1 361:d2405f5a4853 58
rgrover1 361:d2405f5a4853 59
rgrover1 361:d2405f5a4853 60 static __INLINE uint8_t app_sched_queue_empty()
rgrover1 361:d2405f5a4853 61 {
rgrover1 361:d2405f5a4853 62 uint8_t tmp = m_queue_start_index;
rgrover1 361:d2405f5a4853 63 return m_queue_end_index == tmp;
rgrover1 361:d2405f5a4853 64 }
rgrover1 361:d2405f5a4853 65
rgrover1 361:d2405f5a4853 66 /**@brief Macro for checking if a queue is empty. */
rgrover1 361:d2405f5a4853 67 #define APP_SCHED_QUEUE_EMPTY() app_sched_queue_empty()
rgrover1 361:d2405f5a4853 68
rgrover1 361:d2405f5a4853 69
rgrover1 361:d2405f5a4853 70 uint32_t app_sched_init(uint16_t event_size, uint16_t queue_size, void * p_event_buffer)
rgrover1 361:d2405f5a4853 71 {
rgrover1 361:d2405f5a4853 72 uint16_t data_start_index = (queue_size + 1) * sizeof(event_header_t);
rgrover1 361:d2405f5a4853 73
rgrover1 361:d2405f5a4853 74 // Check that buffer is correctly aligned
rgrover1 361:d2405f5a4853 75 if (!is_word_aligned(p_event_buffer))
rgrover1 361:d2405f5a4853 76 {
rgrover1 361:d2405f5a4853 77 return NRF_ERROR_INVALID_PARAM;
rgrover1 361:d2405f5a4853 78 }
rgrover1 361:d2405f5a4853 79
rgrover1 361:d2405f5a4853 80 // Initialize event scheduler
rgrover1 361:d2405f5a4853 81 m_queue_event_headers = p_event_buffer;
rgrover1 361:d2405f5a4853 82 m_queue_event_data = &((uint8_t *)p_event_buffer)[data_start_index];
rgrover1 361:d2405f5a4853 83 m_queue_end_index = 0;
rgrover1 361:d2405f5a4853 84 m_queue_start_index = 0;
rgrover1 361:d2405f5a4853 85 m_queue_event_size = event_size;
rgrover1 361:d2405f5a4853 86 m_queue_size = queue_size;
rgrover1 361:d2405f5a4853 87
rgrover1 361:d2405f5a4853 88 return NRF_SUCCESS;
rgrover1 361:d2405f5a4853 89 }
rgrover1 361:d2405f5a4853 90
rgrover1 361:d2405f5a4853 91
rgrover1 361:d2405f5a4853 92 uint32_t app_sched_event_put(void * p_event_data,
rgrover1 361:d2405f5a4853 93 uint16_t event_data_size,
rgrover1 361:d2405f5a4853 94 app_sched_event_handler_t handler)
rgrover1 361:d2405f5a4853 95 {
rgrover1 361:d2405f5a4853 96 uint32_t err_code;
rgrover1 361:d2405f5a4853 97
rgrover1 361:d2405f5a4853 98 if (event_data_size <= m_queue_event_size)
rgrover1 361:d2405f5a4853 99 {
rgrover1 361:d2405f5a4853 100 uint16_t event_index = 0xFFFF;
rgrover1 361:d2405f5a4853 101
rgrover1 361:d2405f5a4853 102 CRITICAL_REGION_ENTER();
rgrover1 361:d2405f5a4853 103
rgrover1 361:d2405f5a4853 104 if (!APP_SCHED_QUEUE_FULL())
rgrover1 361:d2405f5a4853 105 {
rgrover1 361:d2405f5a4853 106 event_index = m_queue_end_index;
rgrover1 361:d2405f5a4853 107 m_queue_end_index = next_index(m_queue_end_index);
rgrover1 361:d2405f5a4853 108 }
rgrover1 361:d2405f5a4853 109
rgrover1 361:d2405f5a4853 110 CRITICAL_REGION_EXIT();
rgrover1 361:d2405f5a4853 111
rgrover1 361:d2405f5a4853 112 if (event_index != 0xFFFF)
rgrover1 361:d2405f5a4853 113 {
rgrover1 361:d2405f5a4853 114 // NOTE: This can be done outside the critical region since the event consumer will
rgrover1 361:d2405f5a4853 115 // always be called from the main loop, and will thus never interrupt this code.
rgrover1 361:d2405f5a4853 116 m_queue_event_headers[event_index].handler = handler;
rgrover1 361:d2405f5a4853 117 if ((p_event_data != NULL) && (event_data_size > 0))
rgrover1 361:d2405f5a4853 118 {
rgrover1 361:d2405f5a4853 119 memcpy(&m_queue_event_data[event_index * m_queue_event_size],
rgrover1 361:d2405f5a4853 120 p_event_data,
rgrover1 361:d2405f5a4853 121 event_data_size);
rgrover1 361:d2405f5a4853 122 m_queue_event_headers[event_index].event_data_size = event_data_size;
rgrover1 361:d2405f5a4853 123 }
rgrover1 361:d2405f5a4853 124 else
rgrover1 361:d2405f5a4853 125 {
rgrover1 361:d2405f5a4853 126 m_queue_event_headers[event_index].event_data_size = 0;
rgrover1 361:d2405f5a4853 127 }
rgrover1 361:d2405f5a4853 128
rgrover1 361:d2405f5a4853 129 err_code = NRF_SUCCESS;
rgrover1 361:d2405f5a4853 130 }
rgrover1 361:d2405f5a4853 131 else
rgrover1 361:d2405f5a4853 132 {
rgrover1 361:d2405f5a4853 133 err_code = NRF_ERROR_NO_MEM;
rgrover1 361:d2405f5a4853 134 }
rgrover1 361:d2405f5a4853 135 }
rgrover1 361:d2405f5a4853 136 else
rgrover1 361:d2405f5a4853 137 {
rgrover1 361:d2405f5a4853 138 err_code = NRF_ERROR_INVALID_LENGTH;
rgrover1 361:d2405f5a4853 139 }
rgrover1 361:d2405f5a4853 140
rgrover1 361:d2405f5a4853 141 return err_code;
rgrover1 361:d2405f5a4853 142 }
rgrover1 361:d2405f5a4853 143
rgrover1 361:d2405f5a4853 144
rgrover1 361:d2405f5a4853 145 /**@brief Function for reading the next event from specified event queue.
rgrover1 361:d2405f5a4853 146 *
rgrover1 361:d2405f5a4853 147 * @param[out] pp_event_data Pointer to pointer to event data.
rgrover1 361:d2405f5a4853 148 * @param[out] p_event_data_size Pointer to size of event data.
rgrover1 361:d2405f5a4853 149 * @param[out] p_event_handler Pointer to event handler function pointer.
rgrover1 361:d2405f5a4853 150 *
rgrover1 361:d2405f5a4853 151 * @return NRF_SUCCESS if new event, NRF_ERROR_NOT_FOUND if event queue is empty.
rgrover1 361:d2405f5a4853 152 */
rgrover1 361:d2405f5a4853 153 static uint32_t app_sched_event_get(void ** pp_event_data,
rgrover1 361:d2405f5a4853 154 uint16_t * p_event_data_size,
rgrover1 361:d2405f5a4853 155 app_sched_event_handler_t * p_event_handler)
rgrover1 361:d2405f5a4853 156 {
rgrover1 361:d2405f5a4853 157 uint32_t err_code = NRF_ERROR_NOT_FOUND;
rgrover1 361:d2405f5a4853 158
rgrover1 361:d2405f5a4853 159 if (!APP_SCHED_QUEUE_EMPTY())
rgrover1 361:d2405f5a4853 160 {
rgrover1 361:d2405f5a4853 161 uint16_t event_index;
rgrover1 361:d2405f5a4853 162
rgrover1 361:d2405f5a4853 163 // NOTE: There is no need for a critical region here, as this function will only be called
rgrover1 361:d2405f5a4853 164 // from app_sched_execute() from inside the main loop, so it will never interrupt
rgrover1 361:d2405f5a4853 165 // app_sched_event_put(). Also, updating of (i.e. writing to) the start index will be
rgrover1 361:d2405f5a4853 166 // an atomic operation.
rgrover1 361:d2405f5a4853 167 event_index = m_queue_start_index;
rgrover1 361:d2405f5a4853 168 m_queue_start_index = next_index(m_queue_start_index);
rgrover1 361:d2405f5a4853 169
rgrover1 361:d2405f5a4853 170 *pp_event_data = &m_queue_event_data[event_index * m_queue_event_size];
rgrover1 361:d2405f5a4853 171 *p_event_data_size = m_queue_event_headers[event_index].event_data_size;
rgrover1 361:d2405f5a4853 172 *p_event_handler = m_queue_event_headers[event_index].handler;
rgrover1 361:d2405f5a4853 173
rgrover1 361:d2405f5a4853 174 err_code = NRF_SUCCESS;
rgrover1 361:d2405f5a4853 175 }
rgrover1 361:d2405f5a4853 176
rgrover1 361:d2405f5a4853 177 return err_code;
rgrover1 361:d2405f5a4853 178 }
rgrover1 361:d2405f5a4853 179
rgrover1 361:d2405f5a4853 180
rgrover1 361:d2405f5a4853 181 void app_sched_execute(void)
rgrover1 361:d2405f5a4853 182 {
rgrover1 361:d2405f5a4853 183 void * p_event_data;
rgrover1 361:d2405f5a4853 184 uint16_t event_data_size;
rgrover1 361:d2405f5a4853 185 app_sched_event_handler_t event_handler;
rgrover1 361:d2405f5a4853 186
rgrover1 361:d2405f5a4853 187 // Get next event (if any), and execute handler
rgrover1 361:d2405f5a4853 188 while ((app_sched_event_get(&p_event_data, &event_data_size, &event_handler) == NRF_SUCCESS))
rgrover1 361:d2405f5a4853 189 {
rgrover1 361:d2405f5a4853 190 event_handler(p_event_data, event_data_size);
rgrover1 361:d2405f5a4853 191 }
rgrover1 361:d2405f5a4853 192 }