Junichi Katsu / nRF51822

テスト用

Fork of nRF51822 by Nordic Semiconductor

nordic/nrf-sdk/app_common/app_uart.h@69:936d81c963fe, 2014-09-26 (annotated)

Committer:
Rohit Grover
Date:
Fri Sep 26 14:46:19 2014 +0100
Revision:
69:936d81c963fe
Parent:
37:c29c330d942c 
Release 0.2.1

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



Features

~~~~~~~~



- Turn on the service-changed characteristic by default.



Bugfixes

~~~~~~~~



- Raised the maximum number of supported characteristics/descriptors to 24

  (was 10 previously). We're beginning to find services like Device-

  Information with several characteristics populated.



Compatibility

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



Works with 0.2.0 of BLE_API.

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 app_uart UART module
bogdanm 0:eff01767de02 16 * @{
bogdanm 0:eff01767de02 17 * @ingroup app_common
bogdanm 0:eff01767de02 18 *
bogdanm 0:eff01767de02 19 * @brief UART module interface.
bogdanm 0:eff01767de02 20 */
bogdanm 0:eff01767de02 21
bogdanm 0:eff01767de02 22 #ifndef APP_UART_H__
bogdanm 0:eff01767de02 23 #define APP_UART_H__
bogdanm 0:eff01767de02 24
bogdanm 0:eff01767de02 25 #include <stdint.h>
bogdanm 0:eff01767de02 26 #include <stdbool.h>
Rohit Grover 37:c29c330d942c 27 #include "app_util_platform.h"
bogdanm 0:eff01767de02 28
Rohit Grover 37:c29c330d942c 29 #define UART_PIN_DISCONNECTED 0xFFFFFFFF /**< Value indicating that no pin is connected to this UART register. */
bogdanm 0:eff01767de02 30
bogdanm 0:eff01767de02 31 /**@brief UART Flow Control modes for the peripheral.
bogdanm 0:eff01767de02 32 */
bogdanm 0:eff01767de02 33 typedef enum
bogdanm 0:eff01767de02 34 {
Rohit Grover 37:c29c330d942c 35 APP_UART_FLOW_CONTROL_DISABLED, /**< UART Hw Flow Control is disabled. */
Rohit Grover 37:c29c330d942c 36 APP_UART_FLOW_CONTROL_ENABLED, /**< Standard UART Hw Flow Control is enabled. */
Rohit Grover 37:c29c330d942c 37 APP_UART_FLOW_CONTROL_LOW_POWER /**< Specialized UART Hw Flow Control is used. The Low Power setting allows the nRF51 to Power Off the UART module when CTS is in-active, and re-enabling the UART when the CTS signal becomes active. This allows the nRF51 to safe power by only using the UART module when it is needed by the remote site. */
bogdanm 0:eff01767de02 38 } app_uart_flow_control_t;
bogdanm 0:eff01767de02 39
bogdanm 0:eff01767de02 40 /**@brief UART communication structure holding configuration settings for the peripheral.
bogdanm 0:eff01767de02 41 */
bogdanm 0:eff01767de02 42 typedef struct
bogdanm 0:eff01767de02 43 {
Rohit Grover 37:c29c330d942c 44 uint8_t rx_pin_no; /**< RX pin number. */
Rohit Grover 37:c29c330d942c 45 uint8_t tx_pin_no; /**< TX pin number. */
Rohit Grover 37:c29c330d942c 46 uint8_t rts_pin_no; /**< RTS pin number, only used if flow control is enabled. */
Rohit Grover 37:c29c330d942c 47 uint8_t cts_pin_no; /**< CTS pin number, only used if flow control is enabled. */
Rohit Grover 37:c29c330d942c 48 app_uart_flow_control_t flow_control; /**< Flow control setting, if flow control is used, the system will use low power UART mode, based on CTS signal. */
Rohit Grover 37:c29c330d942c 49 bool use_parity; /**< Even parity if TRUE, no parity if FALSE. */
Rohit Grover 37:c29c330d942c 50 uint32_t baud_rate; /**< Baud rate configuration. */
bogdanm 0:eff01767de02 51 } app_uart_comm_params_t;
bogdanm 0:eff01767de02 52
bogdanm 0:eff01767de02 53 /**@brief UART buffer for transmitting/receiving data.
bogdanm 0:eff01767de02 54 */
bogdanm 0:eff01767de02 55 typedef struct
bogdanm 0:eff01767de02 56 {
Rohit Grover 37:c29c330d942c 57 uint8_t * rx_buf; /**< Pointer to the RX buffer. */
Rohit Grover 37:c29c330d942c 58 uint32_t rx_buf_size; /**< Size of the RX buffer. */
Rohit Grover 37:c29c330d942c 59 uint8_t * tx_buf; /**< Pointer to the TX buffer. */
Rohit Grover 37:c29c330d942c 60 uint32_t tx_buf_size; /**< Size of the TX buffer. */
bogdanm 0:eff01767de02 61 } app_uart_buffers_t;
bogdanm 0:eff01767de02 62
bogdanm 0:eff01767de02 63 /**@brief Enumeration describing current state of the UART.
bogdanm 0:eff01767de02 64 *
bogdanm 0:eff01767de02 65 * @details The connection state can be fetched by the application using the function call
bogdanm 0:eff01767de02 66 * @ref app_uart_get_connection_state.
bogdanm 0:eff01767de02 67 * When hardware flow control is used
bogdanm 0:eff01767de02 68 * - APP_UART_CONNECTED: Communication is ongoing.
bogdanm 0:eff01767de02 69 * - APP_UART_DISCONNECTED: No communication is ongoing.
bogdanm 0:eff01767de02 70 *
bogdanm 0:eff01767de02 71 * When no hardware flow control is used
bogdanm 0:eff01767de02 72 * - APP_UART_CONNECTED: Always returned as bytes can always be received/transmitted.
bogdanm 0:eff01767de02 73 */
bogdanm 0:eff01767de02 74 typedef enum
bogdanm 0:eff01767de02 75 {
Rohit Grover 37:c29c330d942c 76 APP_UART_DISCONNECTED, /**< State indicating that the UART is disconnected and cannot receive or transmit bytes. */
Rohit Grover 37:c29c330d942c 77 APP_UART_CONNECTED /**< State indicating that the UART is connected and ready to receive or transmit bytes. If flow control is disabled, the state will always be connected. */
bogdanm 0:eff01767de02 78 } app_uart_connection_state_t;
bogdanm 0:eff01767de02 79
bogdanm 0:eff01767de02 80 /**@brief Enumeration which defines events used by the UART module upon data reception or error.
bogdanm 0:eff01767de02 81 *
bogdanm 0:eff01767de02 82 * @details The event type is used to indicate the type of additional information in the event
bogdanm 0:eff01767de02 83 * @ref app_uart_evt_t.
bogdanm 0:eff01767de02 84 */
bogdanm 0:eff01767de02 85 typedef enum
bogdanm 0:eff01767de02 86 {
Rohit Grover 37:c29c330d942c 87 APP_UART_DATA_READY, /**< An event indicating that UART data has been received. The data is available in the FIFO and can be fetched using @ref app_uart_get. */
Rohit Grover 37:c29c330d942c 88 APP_UART_FIFO_ERROR, /**< An error in the FIFO module used by the app_uart module has occured. The FIFO error code is stored in app_uart_evt_t.data.error_code field. */
Rohit Grover 37:c29c330d942c 89 APP_UART_COMMUNICATION_ERROR, /**< An communication error has occured during reception. The error is stored in app_uart_evt_t.data.error_communication field. */
Rohit Grover 37:c29c330d942c 90 APP_UART_TX_EMPTY, /**< An event indicating that UART has completed transmission of all available data in the TX FIFO. */
Rohit Grover 37:c29c330d942c 91 APP_UART_DATA, /**< An event indicating that UART data has been received, and data is present in data field. This event is only used when no FIFO is configured. */
bogdanm 0:eff01767de02 92 } app_uart_evt_type_t;
bogdanm 0:eff01767de02 93
bogdanm 0:eff01767de02 94 /**@brief Struct containing events from the UART module.
bogdanm 0:eff01767de02 95 *
bogdanm 0:eff01767de02 96 * @details The app_uart_evt_t is used to notify the application of asynchronous events when data
bogdanm 0:eff01767de02 97 * are received on the UART peripheral or in case an error occured during data reception.
bogdanm 0:eff01767de02 98 */
bogdanm 0:eff01767de02 99 typedef struct
bogdanm 0:eff01767de02 100 {
Rohit Grover 37:c29c330d942c 101 app_uart_evt_type_t evt_type; /**< Type of event. */
bogdanm 0:eff01767de02 102 union
bogdanm 0:eff01767de02 103 {
Rohit Grover 37:c29c330d942c 104 uint32_t error_communication; /**< Field used if evt_type is: APP_UART_COMMUNICATION_ERROR. This field contains the value in the ERRORSRC register for the UART peripheral. The UART_ERRORSRC_x defines from @ref nrf51_bitfields.h can be used to parse the error code. See also the nRF51 Series Reference Manual for specification. */
Rohit Grover 37:c29c330d942c 105 uint32_t error_code; /**< Field used if evt_type is: NRF_ERROR_x. Additional status/error code if the error event type is APP_UART_FIFO_ERROR. This error code refer to errors defined in nrf_error.h. */
Rohit Grover 37:c29c330d942c 106 uint8_t value; /**< Field used if evt_type is: NRF_ERROR_x. Additional status/error code if the error event type is APP_UART_FIFO_ERROR. This error code refer to errors defined in nrf_error.h. */
bogdanm 0:eff01767de02 107 } data;
bogdanm 0:eff01767de02 108 } app_uart_evt_t;
bogdanm 0:eff01767de02 109
bogdanm 0:eff01767de02 110 /**@brief Function for handling app_uart event callback.
bogdanm 0:eff01767de02 111 *
bogdanm 0:eff01767de02 112 * @details Upon an event in the app_uart module this callback function will be called to notify
bogdanm 0:eff01767de02 113 * the applicatioon about the event.
bogdanm 0:eff01767de02 114 *
bogdanm 0:eff01767de02 115 * @param[in] p_app_uart_event Pointer to UART event.
bogdanm 0:eff01767de02 116 */
Rohit Grover 37:c29c330d942c 117
Rohit Grover 37:c29c330d942c 118
Rohit Grover 37:c29c330d942c 119 typedef void (* app_uart_event_handler_t) (app_uart_evt_t * p_app_uart_event);
bogdanm 0:eff01767de02 120
bogdanm 0:eff01767de02 121 /**@brief Macro for safe initialization of the UART module in a single user instance when using
bogdanm 0:eff01767de02 122 * a FIFO together with UART.
bogdanm 0:eff01767de02 123 *
bogdanm 0:eff01767de02 124 * @param[in] P_COMM_PARAMS Pointer to a UART communication structure: app_uart_comm_params_t
bogdanm 0:eff01767de02 125 * @param[in] RX_BUF_SIZE Size of desired RX buffer, must be a power of 2 or ZERO (No FIFO).
bogdanm 0:eff01767de02 126 * @param[in] TX_BUF_SIZE Size of desired TX buffer, must be a power of 2 or ZERO (No FIFO).
bogdanm 0:eff01767de02 127 * @param[in] EVENT_HANDLER Event handler function to be called when an event occurs in the
bogdanm 0:eff01767de02 128 * UART module.
bogdanm 0:eff01767de02 129 * @param[in] IRQ_PRIO IRQ priority, app_irq_priority_t, for the UART module irq handler.
bogdanm 0:eff01767de02 130 * @param[out] ERR_CODE The return value of the UART initialization function will be
bogdanm 0:eff01767de02 131 * written to this parameter.
bogdanm 0:eff01767de02 132 *
bogdanm 0:eff01767de02 133 * @note Since this macro allocates a buffer and registers the module as a GPIOTE user when flow
bogdanm 0:eff01767de02 134 * control is enabled, it must only be called once.
bogdanm 0:eff01767de02 135 */
Rohit Grover 37:c29c330d942c 136 #define APP_UART_FIFO_INIT(P_COMM_PARAMS, RX_BUF_SIZE, TX_BUF_SIZE, EVT_HANDLER, IRQ_PRIO, ERR_CODE) \
bogdanm 0:eff01767de02 137 do \
bogdanm 0:eff01767de02 138 { \
bogdanm 0:eff01767de02 139 uint16_t APP_UART_UID = 0; \
bogdanm 0:eff01767de02 140 app_uart_buffers_t buffers; \
bogdanm 0:eff01767de02 141 static uint8_t rx_buf[RX_BUF_SIZE]; \
bogdanm 0:eff01767de02 142 static uint8_t tx_buf[TX_BUF_SIZE]; \
bogdanm 0:eff01767de02 143 \
bogdanm 0:eff01767de02 144 buffers.rx_buf = rx_buf; \
Rohit Grover 37:c29c330d942c 145 buffers.rx_buf_size = sizeof (rx_buf); \
bogdanm 0:eff01767de02 146 buffers.tx_buf = tx_buf; \
Rohit Grover 37:c29c330d942c 147 buffers.tx_buf_size = sizeof (tx_buf); \
bogdanm 0:eff01767de02 148 ERR_CODE = app_uart_init(P_COMM_PARAMS, &buffers, EVT_HANDLER, IRQ_PRIO, &APP_UART_UID); \
bogdanm 0:eff01767de02 149 } while (0)
bogdanm 0:eff01767de02 150
bogdanm 0:eff01767de02 151 /**@brief Macro for safe initialization of the UART module in a single user instance.
bogdanm 0:eff01767de02 152 *
bogdanm 0:eff01767de02 153 * @param[in] P_COMM_PARAMS Pointer to a UART communication structure: app_uart_comm_params_t
bogdanm 0:eff01767de02 154 * @param[in] EVENT_HANDLER Event handler function to be called when an event occurs in the
bogdanm 0:eff01767de02 155 * UART module.
bogdanm 0:eff01767de02 156 * @param[in] IRQ_PRIO IRQ priority, app_irq_priority_t, for the UART module irq handler.
bogdanm 0:eff01767de02 157 * @param[out] ERR_CODE The return value of the UART initialization function will be
bogdanm 0:eff01767de02 158 * written to this parameter.
bogdanm 0:eff01767de02 159 *
bogdanm 0:eff01767de02 160 * @note Since this macro allocates registers the module as a GPIOTE user when flow control is
bogdanm 0:eff01767de02 161 * enabled, it must only be called once.
bogdanm 0:eff01767de02 162 */
bogdanm 0:eff01767de02 163 #define APP_UART_INIT(P_COMM_PARAMS, EVT_HANDLER, IRQ_PRIO, ERR_CODE) \
bogdanm 0:eff01767de02 164 do \
bogdanm 0:eff01767de02 165 { \
bogdanm 0:eff01767de02 166 uint16_t APP_UART_UID = 0; \
bogdanm 0:eff01767de02 167 ERR_CODE = app_uart_init(P_COMM_PARAMS, NULL, EVT_HANDLER, IRQ_PRIO, &APP_UART_UID); \
bogdanm 0:eff01767de02 168 } while (0)
bogdanm 0:eff01767de02 169
bogdanm 0:eff01767de02 170 /**@brief Function for initializing the UART module. Use this initialization when several instances of the UART
bogdanm 0:eff01767de02 171 * module are needed.
bogdanm 0:eff01767de02 172 *
bogdanm 0:eff01767de02 173 * @details This initialization will return a UART user id for the caller. The UART user id must be
bogdanm 0:eff01767de02 174 * used upon re-initialization of the UART or closing of the module for the user.
bogdanm 0:eff01767de02 175 * If single instance usage is needed, the APP_UART_INIT() macro should be used instead.
bogdanm 0:eff01767de02 176 *
bogdanm 0:eff01767de02 177 * @note Normally single instance initialization should be done using the APP_UART_INIT() or
bogdanm 0:eff01767de02 178 * APP_UART_INIT_FIFO() macro depending on whether the FIFO should be used by the UART, as
bogdanm 0:eff01767de02 179 * that will allocate the buffers needed by the UART module (including aligning the buffer
bogdanm 0:eff01767de02 180 * correctly).
bogdanm 0:eff01767de02 181
bogdanm 0:eff01767de02 182 * @param[in] p_comm_params Pin and communication parameters.
bogdanm 0:eff01767de02 183 * @param[in] p_buffers RX and TX buffers, NULL is FIFO is not used.
bogdanm 0:eff01767de02 184 * @param[in] error_handler Function to be called in case of an error.
bogdanm 0:eff01767de02 185 * @param[in] app_irq_priority Interrupt priority level.
bogdanm 0:eff01767de02 186 * @param[in,out] p_uart_uid User id for the UART module. The p_uart_uid must be used if
bogdanm 0:eff01767de02 187 * re-initialization and/or closing of the UART module is needed.
bogdanm 0:eff01767de02 188 * If the value pointed to by p_uart_uid is zero, this is
bogdanm 0:eff01767de02 189 * considdered a first time initialization. Otherwise this is
bogdanm 0:eff01767de02 190 * considered a re-initialization for the user with id *p_uart_uid.
bogdanm 0:eff01767de02 191 *
bogdanm 0:eff01767de02 192 * @retval NRF_SUCCESS If successful initialization.
bogdanm 0:eff01767de02 193 * @retval NRF_ERROR_INVALID_LENGTH If a provided buffer is not a power of two.
bogdanm 0:eff01767de02 194 * @retval NRF_ERROR_NULL If one of the provided buffers is a NULL pointer.
bogdanm 0:eff01767de02 195 *
bogdanm 0:eff01767de02 196 * Those errors are propagated by the UART module to the caller upon registration when Hardware Flow
bogdanm 0:eff01767de02 197 * Control is enabled. When Hardware Flow Control is not used, those errors cannot occur.
bogdanm 0:eff01767de02 198 * @retval NRF_ERROR_INVALID_STATE The GPIOTE module is not in a valid state when registering
bogdanm 0:eff01767de02 199 * the UART module as a user.
bogdanm 0:eff01767de02 200 * @retval NRF_ERROR_INVALID_PARAM The UART module provides an invalid callback function when
bogdanm 0:eff01767de02 201 * registering the UART module as a user.
bogdanm 0:eff01767de02 202 * Or the value pointed to by *p_uart_uid is not a valid
bogdanm 0:eff01767de02 203 * GPIOTE number.
bogdanm 0:eff01767de02 204 * @retval NRF_ERROR_NO_MEM GPIOTE module has reached the maximum number of users.
bogdanm 0:eff01767de02 205 */
bogdanm 0:eff01767de02 206 uint32_t app_uart_init(const app_uart_comm_params_t * p_comm_params,
Rohit Grover 37:c29c330d942c 207 app_uart_buffers_t * p_buffers,
Rohit Grover 37:c29c330d942c 208 app_uart_event_handler_t error_handler,
Rohit Grover 37:c29c330d942c 209 app_irq_priority_t irq_priority,
Rohit Grover 37:c29c330d942c 210 uint16_t * p_uart_uid);
bogdanm 0:eff01767de02 211
bogdanm 0:eff01767de02 212 /**@brief Function for getting a byte from the UART.
bogdanm 0:eff01767de02 213 *
bogdanm 0:eff01767de02 214 * @details This function will get the next byte from the RX buffer. If the RX buffer is empty
Rohit Grover 37:c29c330d942c 215 * an error code will be returned and the app_uart module will generate an event upon
bogdanm 0:eff01767de02 216 * reception of the first byte which is added to the RX buffer.
bogdanm 0:eff01767de02 217 *
bogdanm 0:eff01767de02 218 * @param[out] p_byte Pointer to an address where next byte received on the UART will be copied.
bogdanm 0:eff01767de02 219 *
bogdanm 0:eff01767de02 220 * @retval NRF_SUCCESS If a byte has been received and pushed to the pointer provided.
bogdanm 0:eff01767de02 221 * @retval NRF_ERROR_NOT_FOUND If no byte is available in the RX buffer of the app_uart module.
bogdanm 0:eff01767de02 222 */
bogdanm 0:eff01767de02 223 uint32_t app_uart_get(uint8_t * p_byte);
bogdanm 0:eff01767de02 224
bogdanm 0:eff01767de02 225 /**@brief Function for putting a byte on the UART.
bogdanm 0:eff01767de02 226 *
bogdanm 0:eff01767de02 227 * @details This call is non-blocking.
bogdanm 0:eff01767de02 228 *
bogdanm 0:eff01767de02 229 * @param[in] byte Byte to be transmitted on the UART.
bogdanm 0:eff01767de02 230 *
bogdanm 0:eff01767de02 231 * @retval NRF_SUCCESS If the byte was succesfully put on the TX buffer for transmission.
bogdanm 0:eff01767de02 232 * @retval NRF_ERROR_NO_MEM If no more space is available in the TX buffer.
bogdanm 0:eff01767de02 233 * NRF_ERROR_NO_MEM may occur if flow control is enabled and CTS signal
bogdanm 0:eff01767de02 234 * is high for a long period and the buffer fills up.
bogdanm 0:eff01767de02 235 */
bogdanm 0:eff01767de02 236 uint32_t app_uart_put(uint8_t byte);
bogdanm 0:eff01767de02 237
bogdanm 0:eff01767de02 238 /**@brief Function for getting the current state of the UART.
bogdanm 0:eff01767de02 239 *
bogdanm 0:eff01767de02 240 * @details If flow control is disabled, the state is assumed to always be APP_UART_CONNECTED.
bogdanm 0:eff01767de02 241 *
Rohit Grover 37:c29c330d942c 242 * When using flow control the state will be controlled by the CTS. If CTS is set active
bogdanm 0:eff01767de02 243 * by the remote side, or the app_uart module is in the process of transmitting a byte,
bogdanm 0:eff01767de02 244 * app_uart is in APP_UART_CONNECTED state. If CTS is set inactive by remote side app_uart
Rohit Grover 37:c29c330d942c 245 * will not get into APP_UART_DISCONNECTED state until the last byte in the TXD register
bogdanm 0:eff01767de02 246 * is fully transmitted.
bogdanm 0:eff01767de02 247 *
bogdanm 0:eff01767de02 248 * Internal states in the state machine are mapped to the general connected/disconnected
bogdanm 0:eff01767de02 249 * states in the following ways:
bogdanm 0:eff01767de02 250 *
bogdanm 0:eff01767de02 251 * - UART_ON = CONNECTED
bogdanm 0:eff01767de02 252 * - UART_READY = CONNECTED
bogdanm 0:eff01767de02 253 * - UART_WAIT = CONNECTED
bogdanm 0:eff01767de02 254 * - UART_OFF = DISCONNECTED.
bogdanm 0:eff01767de02 255 *
bogdanm 0:eff01767de02 256 * @param[out] p_connection_state Current connection state of the UART.
bogdanm 0:eff01767de02 257 *
bogdanm 0:eff01767de02 258 * @retval NRF_SUCCESS The connection state was succesfully retrieved.
bogdanm 0:eff01767de02 259 */
bogdanm 0:eff01767de02 260 uint32_t app_uart_get_connection_state(app_uart_connection_state_t * p_connection_state);
bogdanm 0:eff01767de02 261
bogdanm 0:eff01767de02 262 /**@brief Function for flushing the RX and TX buffers (Only valid if FIFO is used).
bogdanm 0:eff01767de02 263 * This function does nothing if FIFO is not used.
bogdanm 0:eff01767de02 264 *
bogdanm 0:eff01767de02 265 * @retval NRF_SUCCESS Flushing completed (Current implementation will always succeed).
bogdanm 0:eff01767de02 266 */
bogdanm 0:eff01767de02 267 uint32_t app_uart_flush(void);
bogdanm 0:eff01767de02 268
bogdanm 0:eff01767de02 269 /**@brief Function for closing the UART module.
bogdanm 0:eff01767de02 270 *
bogdanm 0:eff01767de02 271 * @details This function will close any on-going UART transmissions and disable itself in the
bogdanm 0:eff01767de02 272 * GPTIO module.
bogdanm 0:eff01767de02 273 *
bogdanm 0:eff01767de02 274 * @param[in] app_uart_uid User id for the UART module. The app_uart_uid must be identical to the
bogdanm 0:eff01767de02 275 * UART id returned on initialization and which is currently in use.
bogdanm 0:eff01767de02 276
bogdanm 0:eff01767de02 277 * @retval NRF_SUCCESS If successfully closed.
bogdanm 0:eff01767de02 278 * @retval NRF_ERROR_INVALID_PARAM If an invalid user id is provided or the user id differs from
bogdanm 0:eff01767de02 279 * the current active user.
bogdanm 0:eff01767de02 280 */
bogdanm 0:eff01767de02 281 uint32_t app_uart_close(uint16_t app_uart_id);
bogdanm 0:eff01767de02 282
bogdanm 0:eff01767de02 283
Rohit Grover 37:c29c330d942c 284 #endif //APP_UART_H__
bogdanm 0:eff01767de02 285
bogdanm 0:eff01767de02 286 /** @} */