mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_ARM_BEETLE_SOC/TOOLCHAIN_GCC_ARM/drv_uart.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 171:3a7713b1edbc 1 /*************************************************************************************************/
AnnaBridge 171:3a7713b1edbc 2 /*!
AnnaBridge 171:3a7713b1edbc 3 * \file drv_uart.h
AnnaBridge 171:3a7713b1edbc 4 *
AnnaBridge 171:3a7713b1edbc 5 * \brief UART driver.
AnnaBridge 171:3a7713b1edbc 6 *
AnnaBridge 171:3a7713b1edbc 7 * Copyright (c) 2015 ARM, Ltd., all rights reserved.
AnnaBridge 171:3a7713b1edbc 8 * ARM confidential and proprietary.
AnnaBridge 171:3a7713b1edbc 9 *
AnnaBridge 171:3a7713b1edbc 10 * IMPORTANT. Your use of this file is governed by a Software License Agreement
AnnaBridge 171:3a7713b1edbc 11 * ("Agreement") that must be accepted in order to download or otherwise receive a
AnnaBridge 171:3a7713b1edbc 12 * copy of this file. You may not use or copy this file for any purpose other than
AnnaBridge 171:3a7713b1edbc 13 * as described in the Agreement. If you do not agree to all of the terms of the
AnnaBridge 171:3a7713b1edbc 14 * Agreement do not use this file and delete all copies in your possession or control;
AnnaBridge 171:3a7713b1edbc 15 * if you do not have a copy of the Agreement, you must contact ARM, Ltd. prior
AnnaBridge 171:3a7713b1edbc 16 * to any use, copying or further distribution of this software.
AnnaBridge 171:3a7713b1edbc 17 */
AnnaBridge 171:3a7713b1edbc 18 /*************************************************************************************************/
AnnaBridge 171:3a7713b1edbc 19
AnnaBridge 171:3a7713b1edbc 20 #ifndef __DRV_UART_H
AnnaBridge 171:3a7713b1edbc 21 #define __DRV_UART_H
AnnaBridge 171:3a7713b1edbc 22
AnnaBridge 171:3a7713b1edbc 23 #ifdef __cplusplus
AnnaBridge 171:3a7713b1edbc 24 extern "C" {
AnnaBridge 171:3a7713b1edbc 25 #endif
AnnaBridge 171:3a7713b1edbc 26
AnnaBridge 171:3a7713b1edbc 27 /***************************************************************************************************
AnnaBridge 171:3a7713b1edbc 28 ** INCLUDES
AnnaBridge 171:3a7713b1edbc 29 ***************************************************************************************************/
AnnaBridge 171:3a7713b1edbc 30
AnnaBridge 171:3a7713b1edbc 31 #include "chip.h"
AnnaBridge 171:3a7713b1edbc 32 #include "board.h"
AnnaBridge 171:3a7713b1edbc 33
AnnaBridge 171:3a7713b1edbc 34 /***************************************************************************************************
AnnaBridge 171:3a7713b1edbc 35 ** DEFINES
AnnaBridge 171:3a7713b1edbc 36 ***************************************************************************************************/
AnnaBridge 171:3a7713b1edbc 37
AnnaBridge 171:3a7713b1edbc 38 /*--------------------------------------------------------------------------------------------------
AnnaBridge 171:3a7713b1edbc 39 ** ENABLE/DISABLE, ON/OFF DEFINES
AnnaBridge 171:3a7713b1edbc 40 **
AnnaBridge 171:3a7713b1edbc 41 ** DESCRIPTION: For clarity in enable parameters.
AnnaBridge 171:3a7713b1edbc 42 --------------------------------------------------------------------------------------------------*/
AnnaBridge 171:3a7713b1edbc 43
AnnaBridge 171:3a7713b1edbc 44 #ifndef DRV_ENABLE
AnnaBridge 171:3a7713b1edbc 45 #define DRV_ENABLE 1
AnnaBridge 171:3a7713b1edbc 46 #endif
AnnaBridge 171:3a7713b1edbc 47
AnnaBridge 171:3a7713b1edbc 48 #ifndef DRV_DISABLE
AnnaBridge 171:3a7713b1edbc 49 #define DRV_DISABLE 0
AnnaBridge 171:3a7713b1edbc 50 #endif
AnnaBridge 171:3a7713b1edbc 51
AnnaBridge 171:3a7713b1edbc 52 #ifndef DRV_ON
AnnaBridge 171:3a7713b1edbc 53 #define DRV_ON 1
AnnaBridge 171:3a7713b1edbc 54 #endif
AnnaBridge 171:3a7713b1edbc 55
AnnaBridge 171:3a7713b1edbc 56 #ifndef DRV_OFF
AnnaBridge 171:3a7713b1edbc 57 #define DRV_OFF 0
AnnaBridge 171:3a7713b1edbc 58 #endif
AnnaBridge 171:3a7713b1edbc 59
AnnaBridge 171:3a7713b1edbc 60 /*--------------------------------------------------------------------------------------------------
AnnaBridge 171:3a7713b1edbc 61 ** TX/RX DEFINES
AnnaBridge 171:3a7713b1edbc 62 **
AnnaBridge 171:3a7713b1edbc 63 ** DESCRIPTION: For tx/rx argument of driver functions.
AnnaBridge 171:3a7713b1edbc 64 --------------------------------------------------------------------------------------------------*/
AnnaBridge 171:3a7713b1edbc 65
AnnaBridge 171:3a7713b1edbc 66 #define DRV_UART_TX (1u << 0)
AnnaBridge 171:3a7713b1edbc 67 #define DRV_UART_RX (1u << 1)
AnnaBridge 171:3a7713b1edbc 68
AnnaBridge 171:3a7713b1edbc 69 /***************************************************************************************************
AnnaBridge 171:3a7713b1edbc 70 ** TYPES
AnnaBridge 171:3a7713b1edbc 71 ***************************************************************************************************/
AnnaBridge 171:3a7713b1edbc 72
AnnaBridge 171:3a7713b1edbc 73 /*--------------------------------------------------------------------------------------------------
AnnaBridge 171:3a7713b1edbc 74 ** DRV_UART_RX_CALLBACK_t()
AnnaBridge 171:3a7713b1edbc 75 **
AnnaBridge 171:3a7713b1edbc 76 ** DESCRIPTION: Callback for received byte.
AnnaBridge 171:3a7713b1edbc 77 **
AnnaBridge 171:3a7713b1edbc 78 ** PARAMETERS: c Received byte
AnnaBridge 171:3a7713b1edbc 79 **------------------------------------------------------------------------------------------------*/
AnnaBridge 171:3a7713b1edbc 80
AnnaBridge 171:3a7713b1edbc 81 typedef void (*DRV_UART_RX_CALLBACK_t)(uint8_t c);
AnnaBridge 171:3a7713b1edbc 82
AnnaBridge 171:3a7713b1edbc 83 /*--------------------------------------------------------------------------------------------------
AnnaBridge 171:3a7713b1edbc 84 ** DRV_UART_TX_COMPLETE_t()
AnnaBridge 171:3a7713b1edbc 85 **
AnnaBridge 171:3a7713b1edbc 86 ** DESCRIPTION: Callback for transmit interrupt.
AnnaBridge 171:3a7713b1edbc 87 **------------------------------------------------------------------------------------------------*/
AnnaBridge 171:3a7713b1edbc 88
AnnaBridge 171:3a7713b1edbc 89 typedef void (*DRV_UART_TX_CALLBACK_t)(void);
AnnaBridge 171:3a7713b1edbc 90
AnnaBridge 171:3a7713b1edbc 91
AnnaBridge 171:3a7713b1edbc 92 /*--------------------------------------------------------------------------------------------------
AnnaBridge 171:3a7713b1edbc 93 ** DRV_UART_BUF_LEN
AnnaBridge 171:3a7713b1edbc 94 **
AnnaBridge 171:3a7713b1edbc 95 ** DESCRIPTION: The maximum length of printed strings.
AnnaBridge 171:3a7713b1edbc 96 **------------------------------------------------------------------------------------------------*/
AnnaBridge 171:3a7713b1edbc 97 #define DRV_UART_BUF_LEN 128u
AnnaBridge 171:3a7713b1edbc 98
AnnaBridge 171:3a7713b1edbc 99 /*--------------------------------------------------------------------------------------------------
AnnaBridge 171:3a7713b1edbc 100 ** struct drv_console
AnnaBridge 171:3a7713b1edbc 101 **
AnnaBridge 171:3a7713b1edbc 102 ** DESCRIPTION: Access structure of driver.
AnnaBridge 171:3a7713b1edbc 103 --------------------------------------------------------------------------------------------------*/
AnnaBridge 171:3a7713b1edbc 104 struct drv_uart {
AnnaBridge 171:3a7713b1edbc 105 /*----------------------------------------------------------------------------------------------
AnnaBridge 171:3a7713b1edbc 106 ** Initialize()
AnnaBridge 171:3a7713b1edbc 107 **
AnnaBridge 171:3a7713b1edbc 108 ** DESCRIPTION: Initialize UART.
AnnaBridge 171:3a7713b1edbc 109 **
AnnaBridge 171:3a7713b1edbc 110 ** PARAMETERS: baud Baud rate
AnnaBridge 171:3a7713b1edbc 111 ** rx_tx Indicates allowed modes of driver (DRV_UART_RX &/| DRV_UART_TX).
AnnaBridge 171:3a7713b1edbc 112 **--------------------------------------------------------------------------------------------*/
AnnaBridge 171:3a7713b1edbc 113 void (*Initialize)(uint32_t baud, uint32_t rx_tx);
AnnaBridge 171:3a7713b1edbc 114
AnnaBridge 171:3a7713b1edbc 115 /*----------------------------------------------------------------------------------------------
AnnaBridge 171:3a7713b1edbc 116 ** Sleep()
AnnaBridge 171:3a7713b1edbc 117 **
AnnaBridge 171:3a7713b1edbc 118 ** DESCRIPTION: Allow UART settings to be saved before processor enters deep sleep.
AnnaBridge 171:3a7713b1edbc 119 **--------------------------------------------------------------------------------------------*/
AnnaBridge 171:3a7713b1edbc 120 void (*Sleep)(void);
AnnaBridge 171:3a7713b1edbc 121
AnnaBridge 171:3a7713b1edbc 122 /*----------------------------------------------------------------------------------------------
AnnaBridge 171:3a7713b1edbc 123 ** Wake()
AnnaBridge 171:3a7713b1edbc 124 **
AnnaBridge 171:3a7713b1edbc 125 ** DESCRIPTION: Allow UART settings to be restored after processor exits deep sleep.
AnnaBridge 171:3a7713b1edbc 126 **--------------------------------------------------------------------------------------------*/
AnnaBridge 171:3a7713b1edbc 127 void (*Wake)(void);
AnnaBridge 171:3a7713b1edbc 128
AnnaBridge 171:3a7713b1edbc 129 /*----------------------------------------------------------------------------------------------
AnnaBridge 171:3a7713b1edbc 130 ** Receive()
AnnaBridge 171:3a7713b1edbc 131 **
AnnaBridge 171:3a7713b1edbc 132 ** DESCRIPTION: Receive data.
AnnaBridge 171:3a7713b1edbc 133 **
AnnaBridge 171:3a7713b1edbc 134 ** PARAMETERS: buf Pointer to buffer that will receive data
AnnaBridge 171:3a7713b1edbc 135 ** len Number of data bytes to data
AnnaBridge 171:3a7713b1edbc 136 **
AnnaBridge 171:3a7713b1edbc 137 ** RETURNS: Number of bytes receuved
AnnaBridge 171:3a7713b1edbc 138 **--------------------------------------------------------------------------------------------*/
AnnaBridge 171:3a7713b1edbc 139 int32_t (*Receive)(uint8_t *buf, uint32_t len);
AnnaBridge 171:3a7713b1edbc 140
AnnaBridge 171:3a7713b1edbc 141 /*----------------------------------------------------------------------------------------------
AnnaBridge 171:3a7713b1edbc 142 ** Transmit()
AnnaBridge 171:3a7713b1edbc 143 **
AnnaBridge 171:3a7713b1edbc 144 ** DESCRIPTION: Transmit data.
AnnaBridge 171:3a7713b1edbc 145 **
AnnaBridge 171:3a7713b1edbc 146 ** PARAMETERS: buf Pointer to buffer of data to transmit
AnnaBridge 171:3a7713b1edbc 147 ** len Number of data bytes to transmit
AnnaBridge 171:3a7713b1edbc 148 **
AnnaBridge 171:3a7713b1edbc 149 ** RETURNS: Number of bytes transmitted
AnnaBridge 171:3a7713b1edbc 150 **--------------------------------------------------------------------------------------------*/
AnnaBridge 171:3a7713b1edbc 151 int32_t (*Transmit)(const uint8_t *buf, uint32_t len);
AnnaBridge 171:3a7713b1edbc 152
AnnaBridge 171:3a7713b1edbc 153 /*----------------------------------------------------------------------------------------------
AnnaBridge 171:3a7713b1edbc 154 ** SetReceiveHandler()
AnnaBridge 171:3a7713b1edbc 155 **
AnnaBridge 171:3a7713b1edbc 156 ** DESCRIPTION: Set receive handler.
AnnaBridge 171:3a7713b1edbc 157 **
AnnaBridge 171:3a7713b1edbc 158 ** PARAMETERS: cb Pointer to callbak
AnnaBridge 171:3a7713b1edbc 159 **--------------------------------------------------------------------------------------------*/
AnnaBridge 171:3a7713b1edbc 160 void (*SetReceiveHandler)(DRV_UART_RX_CALLBACK_t cb);
AnnaBridge 171:3a7713b1edbc 161
AnnaBridge 171:3a7713b1edbc 162 /*----------------------------------------------------------------------------------------------
AnnaBridge 171:3a7713b1edbc 163 ** SetTransmitHandler()
AnnaBridge 171:3a7713b1edbc 164 **
AnnaBridge 171:3a7713b1edbc 165 ** DESCRIPTION: Set transmit handler.
AnnaBridge 171:3a7713b1edbc 166 **
AnnaBridge 171:3a7713b1edbc 167 ** PARAMETERS: cb Pointer to callbak
AnnaBridge 171:3a7713b1edbc 168 **--------------------------------------------------------------------------------------------*/
AnnaBridge 171:3a7713b1edbc 169 void (*SetTransmitHandler)(DRV_UART_TX_CALLBACK_t cb);
AnnaBridge 171:3a7713b1edbc 170
AnnaBridge 171:3a7713b1edbc 171 /*----------------------------------------------------------------------------------------------
AnnaBridge 171:3a7713b1edbc 172 ** EnableInterrupt()
AnnaBridge 171:3a7713b1edbc 173 **
AnnaBridge 171:3a7713b1edbc 174 ** DESCRIPTION: Enable or disable an interrupt.
AnnaBridge 171:3a7713b1edbc 175 **
AnnaBridge 171:3a7713b1edbc 176 ** PARAMETERS: rx_tx Select between receive (DRV_UART_RX) or transmit (DRV_UART_TX) interrupt.
AnnaBridge 171:3a7713b1edbc 177 ** enable Indicates whether interrupt should be enable (not 0) or disabled (0).
AnnaBridge 171:3a7713b1edbc 178 **--------------------------------------------------------------------------------------------*/
AnnaBridge 171:3a7713b1edbc 179 void (*EnableInterrupt)(uint32_t rx_tx, int32_t enable);
AnnaBridge 171:3a7713b1edbc 180 };
AnnaBridge 171:3a7713b1edbc 181
AnnaBridge 171:3a7713b1edbc 182 #ifdef __cplusplus
AnnaBridge 171:3a7713b1edbc 183 }
AnnaBridge 171:3a7713b1edbc 184 #endif
AnnaBridge 171:3a7713b1edbc 185
AnnaBridge 171:3a7713b1edbc 186 #endif /* __DRV_UART_H */