nochanges
Dependents: BLE_Acceleration_Statejudging
Fork of nRF51822 by
nordic/nrf-sdk/app_common/hci_mem_pool.h@37:c29c330d942c, 2014-07-07 (annotated)
- Committer:
- Rohit Grover
- Date:
- Mon Jul 07 13:43:31 2014 +0100
- Revision:
- 37:c29c330d942c
- Parent:
- 0:eff01767de02
changes required to upgrade to V7 of the soft-device
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
bogdanm | 0:eff01767de02 | 1 | /* Copyright (c) 2013 Nordic Semiconductor. All Rights Reserved. |
bogdanm | 0:eff01767de02 | 2 | * |
bogdanm | 0:eff01767de02 | 3 | * The information contained herein is property of Nordic Semiconductor ASA. |
bogdanm | 0:eff01767de02 | 4 | * Terms and conditions of usage are described in detail in NORDIC |
bogdanm | 0:eff01767de02 | 5 | * SEMICONDUCTOR STANDARD SOFTWARE LICENSE AGREEMENT. |
bogdanm | 0:eff01767de02 | 6 | * |
bogdanm | 0:eff01767de02 | 7 | * Licensees are granted free, non-transferable use of the information. NO |
bogdanm | 0:eff01767de02 | 8 | * WARRANTY of ANY KIND is provided. This heading must NOT be removed from |
bogdanm | 0:eff01767de02 | 9 | * the file. |
bogdanm | 0:eff01767de02 | 10 | * |
bogdanm | 0:eff01767de02 | 11 | */ |
bogdanm | 0:eff01767de02 | 12 | |
bogdanm | 0:eff01767de02 | 13 | /** @file |
bogdanm | 0:eff01767de02 | 14 | * |
bogdanm | 0:eff01767de02 | 15 | * @defgroup memory_pool Memory pool |
bogdanm | 0:eff01767de02 | 16 | * @{ |
bogdanm | 0:eff01767de02 | 17 | * @ingroup app_common |
bogdanm | 0:eff01767de02 | 18 | * |
bogdanm | 0:eff01767de02 | 19 | * @brief Memory pool implementation |
bogdanm | 0:eff01767de02 | 20 | * |
bogdanm | 0:eff01767de02 | 21 | * Memory pool implementation, based on circular buffer data structure, which supports asynchronous |
bogdanm | 0:eff01767de02 | 22 | * processing of RX data. The current default implementation supports 1 TX buffer and 4 RX buffers. |
bogdanm | 0:eff01767de02 | 23 | * The memory managed by the pool is allocated from static storage instead of heap. The internal |
bogdanm | 0:eff01767de02 | 24 | * design of the circular buffer implementing the RX memory layout is illustrated in the picture |
bogdanm | 0:eff01767de02 | 25 | * below. |
bogdanm | 0:eff01767de02 | 26 | * |
bogdanm | 0:eff01767de02 | 27 | * @image html memory_pool.png "Circular buffer design" |
bogdanm | 0:eff01767de02 | 28 | * |
bogdanm | 0:eff01767de02 | 29 | * The expected call order for the RX APIs is as follows: |
bogdanm | 0:eff01767de02 | 30 | * - hci_mem_pool_rx_produce |
bogdanm | 0:eff01767de02 | 31 | * - hci_mem_pool_rx_data_size_set |
bogdanm | 0:eff01767de02 | 32 | * - hci_mem_pool_rx_extract |
bogdanm | 0:eff01767de02 | 33 | * - hci_mem_pool_rx_consume |
bogdanm | 0:eff01767de02 | 34 | * |
bogdanm | 0:eff01767de02 | 35 | * @warning If the above mentioned expected call order is violated the end result can be undefined. |
bogdanm | 0:eff01767de02 | 36 | * |
bogdanm | 0:eff01767de02 | 37 | * \par Component specific configuration options |
bogdanm | 0:eff01767de02 | 38 | * |
bogdanm | 0:eff01767de02 | 39 | * The following compile time configuration options are available to suit various implementations: |
bogdanm | 0:eff01767de02 | 40 | * - TX_BUF_SIZE TX buffer size in bytes. |
bogdanm | 0:eff01767de02 | 41 | * - RX_BUF_SIZE RX buffer size in bytes. |
bogdanm | 0:eff01767de02 | 42 | * - RX_BUF_QUEUE_SIZE RX buffer element size. |
bogdanm | 0:eff01767de02 | 43 | */ |
bogdanm | 0:eff01767de02 | 44 | |
bogdanm | 0:eff01767de02 | 45 | #ifndef HCI_MEM_POOL_H__ |
bogdanm | 0:eff01767de02 | 46 | #define HCI_MEM_POOL_H__ |
bogdanm | 0:eff01767de02 | 47 | |
bogdanm | 0:eff01767de02 | 48 | #include <stdint.h> |
bogdanm | 0:eff01767de02 | 49 | #include "nrf_error.h" |
bogdanm | 0:eff01767de02 | 50 | |
bogdanm | 0:eff01767de02 | 51 | /**@brief Function for opening the module. |
bogdanm | 0:eff01767de02 | 52 | * |
bogdanm | 0:eff01767de02 | 53 | * @retval NRF_SUCCESS Operation success. |
bogdanm | 0:eff01767de02 | 54 | */ |
bogdanm | 0:eff01767de02 | 55 | uint32_t hci_mem_pool_open(void); |
bogdanm | 0:eff01767de02 | 56 | |
bogdanm | 0:eff01767de02 | 57 | /**@brief Function for closing the module. |
bogdanm | 0:eff01767de02 | 58 | * |
bogdanm | 0:eff01767de02 | 59 | * @retval NRF_SUCCESS Operation success. |
bogdanm | 0:eff01767de02 | 60 | */ |
bogdanm | 0:eff01767de02 | 61 | uint32_t hci_mem_pool_close(void); |
bogdanm | 0:eff01767de02 | 62 | |
bogdanm | 0:eff01767de02 | 63 | /**@brief Function for allocating requested amount of TX memory. |
bogdanm | 0:eff01767de02 | 64 | * |
bogdanm | 0:eff01767de02 | 65 | * @param[out] pp_buffer Pointer to the allocated memory. |
bogdanm | 0:eff01767de02 | 66 | * |
bogdanm | 0:eff01767de02 | 67 | * @retval NRF_SUCCESS Operation success. Memory was allocated. |
bogdanm | 0:eff01767de02 | 68 | * @retval NRF_ERROR_NO_MEM Operation failure. No memory available for allocation. |
bogdanm | 0:eff01767de02 | 69 | * @retval NRF_ERROR_NULL Operation failure. NULL pointer supplied. |
bogdanm | 0:eff01767de02 | 70 | */ |
bogdanm | 0:eff01767de02 | 71 | uint32_t hci_mem_pool_tx_alloc(void ** pp_buffer); |
bogdanm | 0:eff01767de02 | 72 | |
bogdanm | 0:eff01767de02 | 73 | /**@brief Function for freeing previously allocated TX memory. |
bogdanm | 0:eff01767de02 | 74 | * |
bogdanm | 0:eff01767de02 | 75 | * @note Memory management follows the FIFO principle meaning that free() order must match the |
bogdanm | 0:eff01767de02 | 76 | * alloc(...) order, which is the reason for omitting exact memory block identifier as an |
bogdanm | 0:eff01767de02 | 77 | * input parameter. |
bogdanm | 0:eff01767de02 | 78 | * |
bogdanm | 0:eff01767de02 | 79 | * @retval NRF_SUCCESS Operation success. Memory was freed. |
bogdanm | 0:eff01767de02 | 80 | */ |
bogdanm | 0:eff01767de02 | 81 | uint32_t hci_mem_pool_tx_free(void); |
bogdanm | 0:eff01767de02 | 82 | |
bogdanm | 0:eff01767de02 | 83 | /**@brief Function for producing a free RX memory block for usage. |
bogdanm | 0:eff01767de02 | 84 | * |
bogdanm | 0:eff01767de02 | 85 | * @note Upon produce request amount being 0, NRF_SUCCESS is returned. |
bogdanm | 0:eff01767de02 | 86 | * |
bogdanm | 0:eff01767de02 | 87 | * @param[in] length Amount, in bytes, of free memory to be produced. |
bogdanm | 0:eff01767de02 | 88 | * @param[out] pp_buffer Pointer to the allocated memory. |
bogdanm | 0:eff01767de02 | 89 | * |
bogdanm | 0:eff01767de02 | 90 | * @retval NRF_SUCCESS Operation success. Free RX memory block produced. |
bogdanm | 0:eff01767de02 | 91 | * @retval NRF_ERROR_NO_MEM Operation failure. No suitable memory available for allocation. |
bogdanm | 0:eff01767de02 | 92 | * @retval NRF_ERROR_DATA_SIZE Operation failure. Request size exceeds limit. |
bogdanm | 0:eff01767de02 | 93 | * @retval NRF_ERROR_NULL Operation failure. NULL pointer supplied. |
bogdanm | 0:eff01767de02 | 94 | */ |
bogdanm | 0:eff01767de02 | 95 | uint32_t hci_mem_pool_rx_produce(uint32_t length, void ** pp_buffer); |
bogdanm | 0:eff01767de02 | 96 | |
bogdanm | 0:eff01767de02 | 97 | /**@brief Function for setting the length of the last produced RX memory block. |
bogdanm | 0:eff01767de02 | 98 | * |
bogdanm | 0:eff01767de02 | 99 | * @warning If call to this API is omitted the end result is that the following call to |
bogdanm | 0:eff01767de02 | 100 | * mem_pool_rx_extract will return incorrect data in the p_length output parameter. |
bogdanm | 0:eff01767de02 | 101 | * |
bogdanm | 0:eff01767de02 | 102 | * @param[in] length Amount, in bytes, of actual memory used. |
bogdanm | 0:eff01767de02 | 103 | * |
bogdanm | 0:eff01767de02 | 104 | * @retval NRF_SUCCESS Operation success. Length was set. |
bogdanm | 0:eff01767de02 | 105 | */ |
bogdanm | 0:eff01767de02 | 106 | uint32_t hci_mem_pool_rx_data_size_set(uint32_t length); |
bogdanm | 0:eff01767de02 | 107 | |
bogdanm | 0:eff01767de02 | 108 | /**@brief Function for extracting a packet, which has been filled with read data, for further |
bogdanm | 0:eff01767de02 | 109 | * processing. |
bogdanm | 0:eff01767de02 | 110 | * |
bogdanm | 0:eff01767de02 | 111 | * @param[out] pp_buffer Pointer to the packet data. |
bogdanm | 0:eff01767de02 | 112 | * @param[out] p_length Length of packet data in bytes. |
bogdanm | 0:eff01767de02 | 113 | * |
bogdanm | 0:eff01767de02 | 114 | * @retval NRF_SUCCESS Operation success. |
bogdanm | 0:eff01767de02 | 115 | * @retval NRF_ERROR_NO_MEM Operation failure. No packet available to extract. |
bogdanm | 0:eff01767de02 | 116 | * @retval NRF_ERROR_NULL Operation failure. NULL pointer supplied. |
bogdanm | 0:eff01767de02 | 117 | */ |
bogdanm | 0:eff01767de02 | 118 | uint32_t hci_mem_pool_rx_extract(uint8_t ** pp_buffer, uint32_t * p_length); |
bogdanm | 0:eff01767de02 | 119 | |
bogdanm | 0:eff01767de02 | 120 | /**@brief Function for freeing previously extracted packet, which has been filled with read data. |
bogdanm | 0:eff01767de02 | 121 | * |
bogdanm | 0:eff01767de02 | 122 | * @param[in] p_buffer Pointer to consumed buffer. |
bogdanm | 0:eff01767de02 | 123 | * |
bogdanm | 0:eff01767de02 | 124 | * @retval NRF_SUCCESS Operation success. |
bogdanm | 0:eff01767de02 | 125 | * @retval NRF_ERROR_NO_MEM Operation failure. No packet available to free. |
bogdanm | 0:eff01767de02 | 126 | * @retval NRF_ERROR_INVALID_ADDR Operation failure. Not a valid pointer. |
bogdanm | 0:eff01767de02 | 127 | */ |
bogdanm | 0:eff01767de02 | 128 | uint32_t hci_mem_pool_rx_consume(uint8_t * p_buffer); |
bogdanm | 0:eff01767de02 | 129 | |
bogdanm | 0:eff01767de02 | 130 | #endif // HCI_MEM_POOL_H__ |
bogdanm | 0:eff01767de02 | 131 | |
bogdanm | 0:eff01767de02 | 132 | /** @} */ |