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@370:295f76db798e, 2015-07-06 (annotated)

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