Al Williams / nRF51822Copy

Copy of nRF51822 library

Fork of nRF51822 by Nordic Semiconductor

nordic/nrf-sdk/app_common/hci_transport.h@61:6fb5c2c43d35, 2014-09-21 (annotated)

Committer:
wd5gnr
Date:
Sun Sep 21 19:21:08 2014 +0000
Revision:
61:6fb5c2c43d35
Parent:
37:c29c330d942c 
First commit

Who changed what in which revision?

UserRevisionLine numberNew 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 hci_transport HCI Transport
bogdanm 0:eff01767de02 16 * @{
bogdanm 0:eff01767de02 17 * @ingroup app_common
bogdanm 0:eff01767de02 18 *
bogdanm 0:eff01767de02 19 * @brief HCI transport module implementation.
bogdanm 0:eff01767de02 20 *
bogdanm 0:eff01767de02 21 * This module implements certain specific features from the three-wire UART transport layer,
bogdanm 0:eff01767de02 22 * defined by the Bluetooth specification version 4.0 [Vol 4] part D.
bogdanm 0:eff01767de02 23 *
bogdanm 0:eff01767de02 24 * \par Features supported
bogdanm 0:eff01767de02 25 * - Transmission and reception of Vendor Specific HCI packet type application packets.
bogdanm 0:eff01767de02 26 * - Transmission and reception of reliable packets: defined by chapter 6 of the specification.
bogdanm 0:eff01767de02 27 *
bogdanm 0:eff01767de02 28 * \par Features not supported
bogdanm 0:eff01767de02 29 * - Link establishment procedure: defined by chapter 8 of the specification.
bogdanm 0:eff01767de02 30 * - Low power: defined by chapter 9 of the specification.
bogdanm 0:eff01767de02 31 *
bogdanm 0:eff01767de02 32 * \par Implementation specific behaviour
bogdanm 0:eff01767de02 33 * - As Link establishment procedure is not supported following static link configuration parameters
bogdanm 0:eff01767de02 34 * are used:
bogdanm 0:eff01767de02 35 * + TX window size is 1.
bogdanm 0:eff01767de02 36 * + 16 bit CCITT-CRC must be used.
bogdanm 0:eff01767de02 37 * + Out of frame software flow control not supported.
bogdanm 0:eff01767de02 38 * + Parameters specific for resending reliable packets are compile time configurable (clarifed
bogdanm 0:eff01767de02 39 * later in this document).
bogdanm 0:eff01767de02 40 * + Acknowledgement packet transmissions are not timeout driven , meaning they are delivered for
bogdanm 0:eff01767de02 41 * transmission within same context which the corresponding application packet was received.
bogdanm 0:eff01767de02 42 *
bogdanm 0:eff01767de02 43 * \par Implementation specific limitations
bogdanm 0:eff01767de02 44 * Current implementation has the following limitations which will have impact to system wide
bogdanm 0:eff01767de02 45 * behaviour:
bogdanm 0:eff01767de02 46 * - Delayed acknowledgement scheduling not implemented:
bogdanm 0:eff01767de02 47 * There exists a possibility that acknowledgement TX packet and application TX packet will collide
bogdanm 0:eff01767de02 48 * in the TX pipeline having the end result that acknowledgement packet will be excluded from the TX
bogdanm 0:eff01767de02 49 * pipeline which will trigger the retransmission algorithm within the peer protocol entity.
bogdanm 0:eff01767de02 50 * - Delayed retransmission scheduling not implemented:
bogdanm 0:eff01767de02 51 * There exists a possibility that retransmitted application TX packet and acknowledgement TX packet
bogdanm 0:eff01767de02 52 * will collide in the TX pipeline having the end result that retransmitted application TX packet
bogdanm 0:eff01767de02 53 * will be excluded from the TX pipeline.
bogdanm 0:eff01767de02 54 * - Processing of the acknowledgement number from RX application packets:
bogdanm 0:eff01767de02 55 * Acknowledgement number is not processed from the RX application packets having the end result
bogdanm 0:eff01767de02 56 * that unnecessary application packet retransmissions can occur.
bogdanm 0:eff01767de02 57 *
bogdanm 0:eff01767de02 58 * The application TX packet processing flow is illustrated by the statemachine below.
bogdanm 0:eff01767de02 59 *
bogdanm 0:eff01767de02 60 * @image html hci_transport_tx_sm.png "TX - application packet statemachine"
bogdanm 0:eff01767de02 61 *
bogdanm 0:eff01767de02 62 * \par Component specific configuration options
bogdanm 0:eff01767de02 63 *
bogdanm 0:eff01767de02 64 * The following compile time configuration options are available, and used to configure the
bogdanm 0:eff01767de02 65 * application TX packet retransmission interval, in order to suite various application specific
bogdanm 0:eff01767de02 66 * implementations:
bogdanm 0:eff01767de02 67 * - MAC_PACKET_SIZE_IN_BITS Maximum size of a single application packet in bits.
bogdanm 0:eff01767de02 68 * - USED_BAUD_RATE Used uart baudrate.
bogdanm 0:eff01767de02 69 *
bogdanm 0:eff01767de02 70 * The following compile time configuration option is available to configure module specific
bogdanm 0:eff01767de02 71 * behaviour:
bogdanm 0:eff01767de02 72 * - MAX_RETRY_COUNT Max retransmission retry count for applicaton packets.
bogdanm 0:eff01767de02 73 */
bogdanm 0:eff01767de02 74
bogdanm 0:eff01767de02 75 #ifndef HCI_TRANSPORT_H__
bogdanm 0:eff01767de02 76 #define HCI_TRANSPORT_H__
bogdanm 0:eff01767de02 77
bogdanm 0:eff01767de02 78 #include <stdint.h>
bogdanm 0:eff01767de02 79 #include "nrf_error.h"
bogdanm 0:eff01767de02 80
bogdanm 0:eff01767de02 81 /**@brief Generic event callback function events. */
bogdanm 0:eff01767de02 82 typedef enum
bogdanm 0:eff01767de02 83 {
bogdanm 0:eff01767de02 84 HCI_TRANSPORT_RX_RDY, /**< An event indicating that RX packet is ready for read. */
bogdanm 0:eff01767de02 85 HCI_TRANSPORT_EVT_TYPE_MAX /**< Enumeration upper bound. */
bogdanm 0:eff01767de02 86 } hci_transport_evt_type_t;
bogdanm 0:eff01767de02 87
bogdanm 0:eff01767de02 88 /**@brief Struct containing events from the Transport layer.
bogdanm 0:eff01767de02 89 */
bogdanm 0:eff01767de02 90 typedef struct
bogdanm 0:eff01767de02 91 {
bogdanm 0:eff01767de02 92 hci_transport_evt_type_t evt_type; /**< Type of event. */
bogdanm 0:eff01767de02 93 } hci_transport_evt_t;
bogdanm 0:eff01767de02 94
bogdanm 0:eff01767de02 95 /**@brief Transport layer generic event callback function type.
bogdanm 0:eff01767de02 96 *
bogdanm 0:eff01767de02 97 * @param[in] event Transport layer event.
bogdanm 0:eff01767de02 98 */
bogdanm 0:eff01767de02 99 typedef void (*hci_transport_event_handler_t)(hci_transport_evt_t event);
bogdanm 0:eff01767de02 100
bogdanm 0:eff01767de02 101 /**@brief TX done event callback function result codes. */
bogdanm 0:eff01767de02 102 typedef enum
bogdanm 0:eff01767de02 103 {
bogdanm 0:eff01767de02 104 HCI_TRANSPORT_TX_DONE_SUCCESS, /**< Transmission success, peer transport entity has acknowledged the transmission. */
bogdanm 0:eff01767de02 105 HCI_TRANSPORT_TX_DONE_FAILURE /**< Transmission failure. */
bogdanm 0:eff01767de02 106 } hci_transport_tx_done_result_t;
bogdanm 0:eff01767de02 107
bogdanm 0:eff01767de02 108 /**@brief Transport layer TX done event callback function type.
bogdanm 0:eff01767de02 109 *
bogdanm 0:eff01767de02 110 * @param[in] result TX done event result code.
bogdanm 0:eff01767de02 111 */
bogdanm 0:eff01767de02 112 typedef void (*hci_transport_tx_done_handler_t)(hci_transport_tx_done_result_t result);
bogdanm 0:eff01767de02 113
bogdanm 0:eff01767de02 114 /**@brief Function for registering a generic event handler.
bogdanm 0:eff01767de02 115 *
bogdanm 0:eff01767de02 116 * @note Multiple registration requests will overwrite any possible existing registration.
bogdanm 0:eff01767de02 117 *
bogdanm 0:eff01767de02 118 * @param[in] event_handler The function to be called by the transport layer upon an event.
bogdanm 0:eff01767de02 119 *
bogdanm 0:eff01767de02 120 * @retval NRF_SUCCESS Operation success.
bogdanm 0:eff01767de02 121 * @retval NRF_ERROR_NULL Operation failure. NULL pointer supplied.
bogdanm 0:eff01767de02 122 */
bogdanm 0:eff01767de02 123 uint32_t hci_transport_evt_handler_reg(hci_transport_event_handler_t event_handler);
bogdanm 0:eff01767de02 124
bogdanm 0:eff01767de02 125 /**@brief Function for registering a handler for TX done event.
bogdanm 0:eff01767de02 126 *
bogdanm 0:eff01767de02 127 * @note Multiple registration requests will overwrite any possible existing registration.
bogdanm 0:eff01767de02 128 *
bogdanm 0:eff01767de02 129 * @param[in] event_handler The function to be called by the transport layer upon TX done
bogdanm 0:eff01767de02 130 * event.
bogdanm 0:eff01767de02 131 *
bogdanm 0:eff01767de02 132 * @retval NRF_SUCCESS Operation success.
bogdanm 0:eff01767de02 133 * @retval NRF_ERROR_NULL Operation failure. NULL pointer supplied.
bogdanm 0:eff01767de02 134 */
bogdanm 0:eff01767de02 135 uint32_t hci_transport_tx_done_register(hci_transport_tx_done_handler_t event_handler);
bogdanm 0:eff01767de02 136
bogdanm 0:eff01767de02 137 /**@brief Function for opening the transport channel and initializing the transport layer.
bogdanm 0:eff01767de02 138 *
bogdanm 0:eff01767de02 139 * @warning Must not be called for a channel which has been allready opened.
bogdanm 0:eff01767de02 140 *
bogdanm 0:eff01767de02 141 * @retval NRF_SUCCESS Operation success.
bogdanm 0:eff01767de02 142 * @retval NRF_ERROR_INTERNAL Operation failure. Internal error ocurred.
bogdanm 0:eff01767de02 143 */
bogdanm 0:eff01767de02 144 uint32_t hci_transport_open(void);
bogdanm 0:eff01767de02 145
bogdanm 0:eff01767de02 146 /**@brief Function for closing the transport channel.
bogdanm 0:eff01767de02 147 *
bogdanm 0:eff01767de02 148 * @note Can be called multiple times and also for not opened channel.
bogdanm 0:eff01767de02 149 *
bogdanm 0:eff01767de02 150 * @retval NRF_SUCCESS Operation success.
bogdanm 0:eff01767de02 151 */
bogdanm 0:eff01767de02 152 uint32_t hci_transport_close(void);
bogdanm 0:eff01767de02 153
bogdanm 0:eff01767de02 154 /**@brief Function for allocating tx packet memory.
bogdanm 0:eff01767de02 155 *
bogdanm 0:eff01767de02 156 * @param[out] pp_memory Pointer to the packet data.
bogdanm 0:eff01767de02 157 *
bogdanm 0:eff01767de02 158 * @retval NRF_SUCCESS Operation success. Memory was allocated.
bogdanm 0:eff01767de02 159 * @retval NRF_ERROR_NO_MEM Operation failure. No memory available.
bogdanm 0:eff01767de02 160 * @retval NRF_ERROR_NULL Operation failure. NULL pointer supplied.
bogdanm 0:eff01767de02 161 */
bogdanm 0:eff01767de02 162 uint32_t hci_transport_tx_alloc(uint8_t ** pp_memory);
bogdanm 0:eff01767de02 163
bogdanm 0:eff01767de02 164 /**@brief Function for freeing tx packet memory.
bogdanm 0:eff01767de02 165 *
bogdanm 0:eff01767de02 166 * @note Memory management works in FIFO principle meaning that free order must match the alloc
bogdanm 0:eff01767de02 167 * order.
bogdanm 0:eff01767de02 168 *
bogdanm 0:eff01767de02 169 * @retval NRF_SUCCESS Operation success. Memory was freed.
bogdanm 0:eff01767de02 170 */
bogdanm 0:eff01767de02 171 uint32_t hci_transport_tx_free(void);
bogdanm 0:eff01767de02 172
bogdanm 0:eff01767de02 173 /**@brief Function for writing a packet.
bogdanm 0:eff01767de02 174 *
bogdanm 0:eff01767de02 175 * @note Completion of this method does not guarantee that actual peripheral transmission would
bogdanm 0:eff01767de02 176 * have completed.
bogdanm 0:eff01767de02 177 *
bogdanm 0:eff01767de02 178 * @note In case of 0 byte packet length write request, message will consist of only transport
bogdanm 0:eff01767de02 179 * module specific headers.
bogdanm 0:eff01767de02 180 *
bogdanm 0:eff01767de02 181 * @retval NRF_SUCCESS Operation success. Packet was added to the transmission queue
bogdanm 0:eff01767de02 182 * and an event will be send upon transmission completion.
bogdanm 0:eff01767de02 183 * @retval NRF_ERROR_NO_MEM Operation failure. Transmission queue is full and packet was not
bogdanm 0:eff01767de02 184 * added to the transmission queue. User should wait for
bogdanm 0:eff01767de02 185 * a appropriate event prior issuing this operation again.
bogdanm 0:eff01767de02 186 * @retval NRF_ERROR_DATA_SIZE Operation failure. Packet size exceeds limit.
bogdanm 0:eff01767de02 187 * @retval NRF_ERROR_NULL Operation failure. NULL pointer supplied.
bogdanm 0:eff01767de02 188 * @retval NRF_ERROR_INVALID_STATE Operation failure. Channel is not open.
bogdanm 0:eff01767de02 189 */
bogdanm 0:eff01767de02 190 uint32_t hci_transport_pkt_write(const uint8_t * p_buffer, uint32_t length);
bogdanm 0:eff01767de02 191
bogdanm 0:eff01767de02 192 /**@brief Function for extracting received packet.
bogdanm 0:eff01767de02 193 *
bogdanm 0:eff01767de02 194 * @note Extracted memory can't be reused by the underlying transport layer untill freed by call to
bogdanm 0:eff01767de02 195 * hci_transport_rx_pkt_consume().
bogdanm 0:eff01767de02 196 *
bogdanm 0:eff01767de02 197 * @param[out] pp_buffer Pointer to the packet data.
bogdanm 0:eff01767de02 198 * @param[out] p_length Length of packet data in bytes.
bogdanm 0:eff01767de02 199 *
bogdanm 0:eff01767de02 200 * @retval NRF_SUCCESS Operation success. Packet was extracted.
bogdanm 0:eff01767de02 201 * @retval NRF_ERROR_NO_MEM Operation failure. No packet available to extract.
bogdanm 0:eff01767de02 202 * @retval NRF_ERROR_NULL Operation failure. NULL pointer supplied.
bogdanm 0:eff01767de02 203 */
bogdanm 0:eff01767de02 204 uint32_t hci_transport_rx_pkt_extract(uint8_t ** pp_buffer, uint32_t * p_length);
bogdanm 0:eff01767de02 205
bogdanm 0:eff01767de02 206 /**@brief Function for consuming extracted packet described by p_buffer.
bogdanm 0:eff01767de02 207 *
bogdanm 0:eff01767de02 208 * RX memory pointed to by p_buffer is freed and can be reused by the underlying transport layer.
bogdanm 0:eff01767de02 209 *
bogdanm 0:eff01767de02 210 * @param[in] p_buffer Pointer to the buffer that has been consumed.
bogdanm 0:eff01767de02 211 *
bogdanm 0:eff01767de02 212 * @retval NRF_SUCCESS Operation success.
bogdanm 0:eff01767de02 213 * @retval NRF_ERROR_NO_MEM Operation failure. No packet available to consume.
bogdanm 0:eff01767de02 214 * @retval NRF_ERROR_INVALID_ADDR Operation failure. Not a valid pointer.
bogdanm 0:eff01767de02 215 */
bogdanm 0:eff01767de02 216 uint32_t hci_transport_rx_pkt_consume(uint8_t * p_buffer);
bogdanm 0:eff01767de02 217
bogdanm 0:eff01767de02 218 #endif // HCI_TRANSPORT_H__
bogdanm 0:eff01767de02 219
bogdanm 0:eff01767de02 220 /** @} */