Pratyush Mallick / Mbed OS nano_dac

this is testing

noos_mbed/include/uart.h@0:e8a1ba50c46b, 2021-01-14 (annotated)

Committer:
pmallick
Date:
Thu Jan 14 19:12:57 2021 +0530
Revision:
0:e8a1ba50c46b
this is testing

Who changed what in which revision?

UserRevisionLine numberNew contents of line
pmallick 0:e8a1ba50c46b 1 /***************************************************************************//**
pmallick 0:e8a1ba50c46b 2 * @file uart.h
pmallick 0:e8a1ba50c46b 3 * @brief Header file of UART interface.
pmallick 0:e8a1ba50c46b 4 * @author Cristian Pop (cristian.pop@analog.com)
pmallick 0:e8a1ba50c46b 5 ********************************************************************************
pmallick 0:e8a1ba50c46b 6 * Copyright 2019(c) Analog Devices, Inc.
pmallick 0:e8a1ba50c46b 7 *
pmallick 0:e8a1ba50c46b 8 * All rights reserved.
pmallick 0:e8a1ba50c46b 9 *
pmallick 0:e8a1ba50c46b 10 * Redistribution and use in source and binary forms, with or without
pmallick 0:e8a1ba50c46b 11 * modification, are permitted provided that the following conditions are met:
pmallick 0:e8a1ba50c46b 12 * - Redistributions of source code must retain the above copyright
pmallick 0:e8a1ba50c46b 13 * notice, this list of conditions and the following disclaimer.
pmallick 0:e8a1ba50c46b 14 * - Redistributions in binary form must reproduce the above copyright
pmallick 0:e8a1ba50c46b 15 * notice, this list of conditions and the following disclaimer in
pmallick 0:e8a1ba50c46b 16 * the documentation and/or other materials provided with the
pmallick 0:e8a1ba50c46b 17 * distribution.
pmallick 0:e8a1ba50c46b 18 * - Neither the name of Analog Devices, Inc. nor the names of its
pmallick 0:e8a1ba50c46b 19 * contributors may be used to endorse or promote products derived
pmallick 0:e8a1ba50c46b 20 * from this software without specific prior written permission.
pmallick 0:e8a1ba50c46b 21 * - The use of this software may or may not infringe the patent rights
pmallick 0:e8a1ba50c46b 22 * of one or more patent holders. This license does not release you
pmallick 0:e8a1ba50c46b 23 * from the requirement that you obtain separate licenses from these
pmallick 0:e8a1ba50c46b 24 * patent holders to use this software.
pmallick 0:e8a1ba50c46b 25 * - Use of the software either in source or binary form, must be run
pmallick 0:e8a1ba50c46b 26 * on or directly connected to an Analog Devices Inc. component.
pmallick 0:e8a1ba50c46b 27 *
pmallick 0:e8a1ba50c46b 28 * THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR
pmallick 0:e8a1ba50c46b 29 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
pmallick 0:e8a1ba50c46b 30 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
pmallick 0:e8a1ba50c46b 31 * IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT,
pmallick 0:e8a1ba50c46b 32 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
pmallick 0:e8a1ba50c46b 33 * LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR
pmallick 0:e8a1ba50c46b 34 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
pmallick 0:e8a1ba50c46b 35 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
pmallick 0:e8a1ba50c46b 36 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
pmallick 0:e8a1ba50c46b 37 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
pmallick 0:e8a1ba50c46b 38 *******************************************************************************/
pmallick 0:e8a1ba50c46b 39 #ifndef UART_H_
pmallick 0:e8a1ba50c46b 40 #define UART_H_
pmallick 0:e8a1ba50c46b 41
pmallick 0:e8a1ba50c46b 42 /******************************************************************************/
pmallick 0:e8a1ba50c46b 43 /***************************** Include Files **********************************/
pmallick 0:e8a1ba50c46b 44 /******************************************************************************/
pmallick 0:e8a1ba50c46b 45
pmallick 0:e8a1ba50c46b 46 #include <stdint.h>
pmallick 0:e8a1ba50c46b 47
pmallick 0:e8a1ba50c46b 48 /******************************************************************************/
pmallick 0:e8a1ba50c46b 49 /*************************** Types Declarations *******************************/
pmallick 0:e8a1ba50c46b 50 /******************************************************************************/
pmallick 0:e8a1ba50c46b 51
pmallick 0:e8a1ba50c46b 52 /**
pmallick 0:e8a1ba50c46b 53 * @struct uart_init_param
pmallick 0:e8a1ba50c46b 54 * @brief Structure holding the parameters for UART initialization
pmallick 0:e8a1ba50c46b 55 */
pmallick 0:e8a1ba50c46b 56 struct uart_init_param {
pmallick 0:e8a1ba50c46b 57 /** UART Device ID */
pmallick 0:e8a1ba50c46b 58 uint8_t device_id;
pmallick 0:e8a1ba50c46b 59 /** UART Baud Rate */
pmallick 0:e8a1ba50c46b 60 uint32_t baud_rate;
pmallick 0:e8a1ba50c46b 61 /** UART extra parameters (device specific) */
pmallick 0:e8a1ba50c46b 62 void *extra;
pmallick 0:e8a1ba50c46b 63 };
pmallick 0:e8a1ba50c46b 64
pmallick 0:e8a1ba50c46b 65 /**
pmallick 0:e8a1ba50c46b 66 * @struct uart_desc
pmallick 0:e8a1ba50c46b 67 * @brief Stucture holding the UART descriptor.
pmallick 0:e8a1ba50c46b 68 */
pmallick 0:e8a1ba50c46b 69 struct uart_desc {
pmallick 0:e8a1ba50c46b 70 /** UART Device ID */
pmallick 0:e8a1ba50c46b 71 uint8_t device_id;
pmallick 0:e8a1ba50c46b 72 /** UART Baud Rate */
pmallick 0:e8a1ba50c46b 73 uint32_t baud_rate;
pmallick 0:e8a1ba50c46b 74 /** Callback to be called when an operation is done (optional) */
pmallick 0:e8a1ba50c46b 75 void (*callback)(void *callback_ctx, uint32_t event,
pmallick 0:e8a1ba50c46b 76 void *extra);
pmallick 0:e8a1ba50c46b 77 /** Parameter to be passed to the callback as app_param */
pmallick 0:e8a1ba50c46b 78 void *callback_ctx;
pmallick 0:e8a1ba50c46b 79 /** UART extra parameters (device specific) */
pmallick 0:e8a1ba50c46b 80 void *extra;
pmallick 0:e8a1ba50c46b 81 };
pmallick 0:e8a1ba50c46b 82
pmallick 0:e8a1ba50c46b 83 /******************************************************************************/
pmallick 0:e8a1ba50c46b 84 /************************ Functions Declarations ******************************/
pmallick 0:e8a1ba50c46b 85 /******************************************************************************/
pmallick 0:e8a1ba50c46b 86
pmallick 0:e8a1ba50c46b 87 /* Read data from UART. Blocking function */
pmallick 0:e8a1ba50c46b 88 int32_t uart_read(struct uart_desc *desc, uint8_t *data, uint32_t bytes_number);
pmallick 0:e8a1ba50c46b 89
pmallick 0:e8a1ba50c46b 90 /* Write data to UART. Blocking function */
pmallick 0:e8a1ba50c46b 91 int32_t uart_write(struct uart_desc *desc, const uint8_t *data,
pmallick 0:e8a1ba50c46b 92 uint32_t bytes_number);
pmallick 0:e8a1ba50c46b 93
pmallick 0:e8a1ba50c46b 94 /* Read data from UART. Non blocking function */
pmallick 0:e8a1ba50c46b 95 int32_t uart_read_nonblocking(struct uart_desc *desc, uint8_t *data,
pmallick 0:e8a1ba50c46b 96 uint32_t bytes_number);
pmallick 0:e8a1ba50c46b 97
pmallick 0:e8a1ba50c46b 98 /* Write data to UART. Non blocking function*/
pmallick 0:e8a1ba50c46b 99 int32_t uart_write_nonblocking(struct uart_desc *desc, const uint8_t *data,
pmallick 0:e8a1ba50c46b 100 uint32_t bytes_number);
pmallick 0:e8a1ba50c46b 101
pmallick 0:e8a1ba50c46b 102 /* Initialize the UART communication peripheral. */
pmallick 0:e8a1ba50c46b 103 int32_t uart_init(struct uart_desc **desc, struct uart_init_param *param);
pmallick 0:e8a1ba50c46b 104
pmallick 0:e8a1ba50c46b 105 /* Free the resources allocated by uart_init(). */
pmallick 0:e8a1ba50c46b 106 int32_t uart_remove(struct uart_desc *desc);
pmallick 0:e8a1ba50c46b 107
pmallick 0:e8a1ba50c46b 108 /* Check if UART errors occurred. */
pmallick 0:e8a1ba50c46b 109 uint32_t uart_get_errors(struct uart_desc *desc);
pmallick 0:e8a1ba50c46b 110
pmallick 0:e8a1ba50c46b 111 #endif /* UART_H_ */