Giovanni Bauermeister / 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.

Dependencies:   nrf51-sdk

Dependents:  

Fork of nRF51822 by Lancaster University

source/nordic-sdk/components/libraries/hci/hci_mem_pool.h@615:65ea2acfc6a2, 2016-04-06 (annotated)

Committer:
LancasterUniversity
Date:
Wed Apr 06 22:38:43 2016 +0100
Revision:
615:65ea2acfc6a2
Synchronized with git rev 60a7c0c0

Author: Rohit Grover

bring in the latest changes for BLE::init() where we allow <object, member> tuples for init callback.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
LancasterUniversity 615:65ea2acfc6a2 1 /*
LancasterUniversity 615:65ea2acfc6a2 2 * Copyright (c) Nordic Semiconductor ASA
LancasterUniversity 615:65ea2acfc6a2 3 * All rights reserved.
LancasterUniversity 615:65ea2acfc6a2 4 *
LancasterUniversity 615:65ea2acfc6a2 5 * Redistribution and use in source and binary forms, with or without modification,
LancasterUniversity 615:65ea2acfc6a2 6 * are permitted provided that the following conditions are met:
LancasterUniversity 615:65ea2acfc6a2 7 *
LancasterUniversity 615:65ea2acfc6a2 8 * 1. Redistributions of source code must retain the above copyright notice, this
LancasterUniversity 615:65ea2acfc6a2 9 * list of conditions and the following disclaimer.
LancasterUniversity 615:65ea2acfc6a2 10 *
LancasterUniversity 615:65ea2acfc6a2 11 * 2. Redistributions in binary form must reproduce the above copyright notice, this
LancasterUniversity 615:65ea2acfc6a2 12 * list of conditions and the following disclaimer in the documentation and/or
LancasterUniversity 615:65ea2acfc6a2 13 * other materials provided with the distribution.
LancasterUniversity 615:65ea2acfc6a2 14 *
LancasterUniversity 615:65ea2acfc6a2 15 * 3. Neither the name of Nordic Semiconductor ASA nor the names of other
LancasterUniversity 615:65ea2acfc6a2 16 * contributors to this software may be used to endorse or promote products
LancasterUniversity 615:65ea2acfc6a2 17 * derived from this software without specific prior written permission.
LancasterUniversity 615:65ea2acfc6a2 18 *
LancasterUniversity 615:65ea2acfc6a2 19 *
LancasterUniversity 615:65ea2acfc6a2 20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
LancasterUniversity 615:65ea2acfc6a2 21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
LancasterUniversity 615:65ea2acfc6a2 22 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
LancasterUniversity 615:65ea2acfc6a2 23 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
LancasterUniversity 615:65ea2acfc6a2 24 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
LancasterUniversity 615:65ea2acfc6a2 25 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LancasterUniversity 615:65ea2acfc6a2 26 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
LancasterUniversity 615:65ea2acfc6a2 27 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
LancasterUniversity 615:65ea2acfc6a2 28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
LancasterUniversity 615:65ea2acfc6a2 29 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
LancasterUniversity 615:65ea2acfc6a2 30 *
LancasterUniversity 615:65ea2acfc6a2 31 */
LancasterUniversity 615:65ea2acfc6a2 32
LancasterUniversity 615:65ea2acfc6a2 33 /** @file
LancasterUniversity 615:65ea2acfc6a2 34 *
LancasterUniversity 615:65ea2acfc6a2 35 * @defgroup memory_pool Memory pool
LancasterUniversity 615:65ea2acfc6a2 36 * @{
LancasterUniversity 615:65ea2acfc6a2 37 * @ingroup app_common
LancasterUniversity 615:65ea2acfc6a2 38 *
LancasterUniversity 615:65ea2acfc6a2 39 * @brief Memory pool implementation
LancasterUniversity 615:65ea2acfc6a2 40 *
LancasterUniversity 615:65ea2acfc6a2 41 * Memory pool implementation, based on circular buffer data structure, which supports asynchronous
LancasterUniversity 615:65ea2acfc6a2 42 * processing of RX data. The current default implementation supports 1 TX buffer and 4 RX buffers.
LancasterUniversity 615:65ea2acfc6a2 43 * The memory managed by the pool is allocated from static storage instead of heap. The internal
LancasterUniversity 615:65ea2acfc6a2 44 * design of the circular buffer implementing the RX memory layout is illustrated in the picture
LancasterUniversity 615:65ea2acfc6a2 45 * below.
LancasterUniversity 615:65ea2acfc6a2 46 *
LancasterUniversity 615:65ea2acfc6a2 47 * @image html memory_pool.png "Circular buffer design"
LancasterUniversity 615:65ea2acfc6a2 48 *
LancasterUniversity 615:65ea2acfc6a2 49 * The expected call order for the RX APIs is as follows:
LancasterUniversity 615:65ea2acfc6a2 50 * - hci_mem_pool_rx_produce
LancasterUniversity 615:65ea2acfc6a2 51 * - hci_mem_pool_rx_data_size_set
LancasterUniversity 615:65ea2acfc6a2 52 * - hci_mem_pool_rx_extract
LancasterUniversity 615:65ea2acfc6a2 53 * - hci_mem_pool_rx_consume
LancasterUniversity 615:65ea2acfc6a2 54 *
LancasterUniversity 615:65ea2acfc6a2 55 * @warning If the above mentioned expected call order is violated the end result can be undefined.
LancasterUniversity 615:65ea2acfc6a2 56 *
LancasterUniversity 615:65ea2acfc6a2 57 * \par Component specific configuration options
LancasterUniversity 615:65ea2acfc6a2 58 *
LancasterUniversity 615:65ea2acfc6a2 59 * The following compile time configuration options are available to suit various implementations:
LancasterUniversity 615:65ea2acfc6a2 60 * - TX_BUF_SIZE TX buffer size in bytes.
LancasterUniversity 615:65ea2acfc6a2 61 * - RX_BUF_SIZE RX buffer size in bytes.
LancasterUniversity 615:65ea2acfc6a2 62 * - RX_BUF_QUEUE_SIZE RX buffer element size.
LancasterUniversity 615:65ea2acfc6a2 63 */
LancasterUniversity 615:65ea2acfc6a2 64
LancasterUniversity 615:65ea2acfc6a2 65 #ifndef HCI_MEM_POOL_H__
LancasterUniversity 615:65ea2acfc6a2 66 #define HCI_MEM_POOL_H__
LancasterUniversity 615:65ea2acfc6a2 67
LancasterUniversity 615:65ea2acfc6a2 68 #include <stdint.h>
LancasterUniversity 615:65ea2acfc6a2 69 #include "nrf_error.h"
LancasterUniversity 615:65ea2acfc6a2 70
LancasterUniversity 615:65ea2acfc6a2 71 /**@brief Function for opening the module.
LancasterUniversity 615:65ea2acfc6a2 72 *
LancasterUniversity 615:65ea2acfc6a2 73 * @retval NRF_SUCCESS Operation success.
LancasterUniversity 615:65ea2acfc6a2 74 */
LancasterUniversity 615:65ea2acfc6a2 75 uint32_t hci_mem_pool_open(void);
LancasterUniversity 615:65ea2acfc6a2 76
LancasterUniversity 615:65ea2acfc6a2 77 /**@brief Function for closing the module.
LancasterUniversity 615:65ea2acfc6a2 78 *
LancasterUniversity 615:65ea2acfc6a2 79 * @retval NRF_SUCCESS Operation success.
LancasterUniversity 615:65ea2acfc6a2 80 */
LancasterUniversity 615:65ea2acfc6a2 81 uint32_t hci_mem_pool_close(void);
LancasterUniversity 615:65ea2acfc6a2 82
LancasterUniversity 615:65ea2acfc6a2 83 /**@brief Function for allocating requested amount of TX memory.
LancasterUniversity 615:65ea2acfc6a2 84 *
LancasterUniversity 615:65ea2acfc6a2 85 * @param[out] pp_buffer Pointer to the allocated memory.
LancasterUniversity 615:65ea2acfc6a2 86 *
LancasterUniversity 615:65ea2acfc6a2 87 * @retval NRF_SUCCESS Operation success. Memory was allocated.
LancasterUniversity 615:65ea2acfc6a2 88 * @retval NRF_ERROR_NO_MEM Operation failure. No memory available for allocation.
LancasterUniversity 615:65ea2acfc6a2 89 * @retval NRF_ERROR_NULL Operation failure. NULL pointer supplied.
LancasterUniversity 615:65ea2acfc6a2 90 */
LancasterUniversity 615:65ea2acfc6a2 91 uint32_t hci_mem_pool_tx_alloc(void ** pp_buffer);
LancasterUniversity 615:65ea2acfc6a2 92
LancasterUniversity 615:65ea2acfc6a2 93 /**@brief Function for freeing previously allocated TX memory.
LancasterUniversity 615:65ea2acfc6a2 94 *
LancasterUniversity 615:65ea2acfc6a2 95 * @note Memory management follows the FIFO principle meaning that free() order must match the
LancasterUniversity 615:65ea2acfc6a2 96 * alloc(...) order, which is the reason for omitting exact memory block identifier as an
LancasterUniversity 615:65ea2acfc6a2 97 * input parameter.
LancasterUniversity 615:65ea2acfc6a2 98 *
LancasterUniversity 615:65ea2acfc6a2 99 * @retval NRF_SUCCESS Operation success. Memory was freed.
LancasterUniversity 615:65ea2acfc6a2 100 */
LancasterUniversity 615:65ea2acfc6a2 101 uint32_t hci_mem_pool_tx_free(void);
LancasterUniversity 615:65ea2acfc6a2 102
LancasterUniversity 615:65ea2acfc6a2 103 /**@brief Function for producing a free RX memory block for usage.
LancasterUniversity 615:65ea2acfc6a2 104 *
LancasterUniversity 615:65ea2acfc6a2 105 * @note Upon produce request amount being 0, NRF_SUCCESS is returned.
LancasterUniversity 615:65ea2acfc6a2 106 *
LancasterUniversity 615:65ea2acfc6a2 107 * @param[in] length Amount, in bytes, of free memory to be produced.
LancasterUniversity 615:65ea2acfc6a2 108 * @param[out] pp_buffer Pointer to the allocated memory.
LancasterUniversity 615:65ea2acfc6a2 109 *
LancasterUniversity 615:65ea2acfc6a2 110 * @retval NRF_SUCCESS Operation success. Free RX memory block produced.
LancasterUniversity 615:65ea2acfc6a2 111 * @retval NRF_ERROR_NO_MEM Operation failure. No suitable memory available for allocation.
LancasterUniversity 615:65ea2acfc6a2 112 * @retval NRF_ERROR_DATA_SIZE Operation failure. Request size exceeds limit.
LancasterUniversity 615:65ea2acfc6a2 113 * @retval NRF_ERROR_NULL Operation failure. NULL pointer supplied.
LancasterUniversity 615:65ea2acfc6a2 114 */
LancasterUniversity 615:65ea2acfc6a2 115 uint32_t hci_mem_pool_rx_produce(uint32_t length, void ** pp_buffer);
LancasterUniversity 615:65ea2acfc6a2 116
LancasterUniversity 615:65ea2acfc6a2 117 /**@brief Function for setting the length of the last produced RX memory block.
LancasterUniversity 615:65ea2acfc6a2 118 *
LancasterUniversity 615:65ea2acfc6a2 119 * @warning If call to this API is omitted the end result is that the following call to
LancasterUniversity 615:65ea2acfc6a2 120 * mem_pool_rx_extract will return incorrect data in the p_length output parameter.
LancasterUniversity 615:65ea2acfc6a2 121 *
LancasterUniversity 615:65ea2acfc6a2 122 * @param[in] length Amount, in bytes, of actual memory used.
LancasterUniversity 615:65ea2acfc6a2 123 *
LancasterUniversity 615:65ea2acfc6a2 124 * @retval NRF_SUCCESS Operation success. Length was set.
LancasterUniversity 615:65ea2acfc6a2 125 */
LancasterUniversity 615:65ea2acfc6a2 126 uint32_t hci_mem_pool_rx_data_size_set(uint32_t length);
LancasterUniversity 615:65ea2acfc6a2 127
LancasterUniversity 615:65ea2acfc6a2 128 /**@brief Function for extracting a packet, which has been filled with read data, for further
LancasterUniversity 615:65ea2acfc6a2 129 * processing.
LancasterUniversity 615:65ea2acfc6a2 130 *
LancasterUniversity 615:65ea2acfc6a2 131 * @param[out] pp_buffer Pointer to the packet data.
LancasterUniversity 615:65ea2acfc6a2 132 * @param[out] p_length Length of packet data in bytes.
LancasterUniversity 615:65ea2acfc6a2 133 *
LancasterUniversity 615:65ea2acfc6a2 134 * @retval NRF_SUCCESS Operation success.
LancasterUniversity 615:65ea2acfc6a2 135 * @retval NRF_ERROR_NO_MEM Operation failure. No packet available to extract.
LancasterUniversity 615:65ea2acfc6a2 136 * @retval NRF_ERROR_NULL Operation failure. NULL pointer supplied.
LancasterUniversity 615:65ea2acfc6a2 137 */
LancasterUniversity 615:65ea2acfc6a2 138 uint32_t hci_mem_pool_rx_extract(uint8_t ** pp_buffer, uint32_t * p_length);
LancasterUniversity 615:65ea2acfc6a2 139
LancasterUniversity 615:65ea2acfc6a2 140 /**@brief Function for freeing previously extracted packet, which has been filled with read data.
LancasterUniversity 615:65ea2acfc6a2 141 *
LancasterUniversity 615:65ea2acfc6a2 142 * @param[in] p_buffer Pointer to consumed buffer.
LancasterUniversity 615:65ea2acfc6a2 143 *
LancasterUniversity 615:65ea2acfc6a2 144 * @retval NRF_SUCCESS Operation success.
LancasterUniversity 615:65ea2acfc6a2 145 * @retval NRF_ERROR_NO_MEM Operation failure. No packet available to free.
LancasterUniversity 615:65ea2acfc6a2 146 * @retval NRF_ERROR_INVALID_ADDR Operation failure. Not a valid pointer.
LancasterUniversity 615:65ea2acfc6a2 147 */
LancasterUniversity 615:65ea2acfc6a2 148 uint32_t hci_mem_pool_rx_consume(uint8_t * p_buffer);
LancasterUniversity 615:65ea2acfc6a2 149
LancasterUniversity 615:65ea2acfc6a2 150 #endif // HCI_MEM_POOL_H__
LancasterUniversity 615:65ea2acfc6a2 151
LancasterUniversity 615:65ea2acfc6a2 152 /** @} */