Diff: source/hic_hal/uart.h

Revision:

0:01f31e923fe2

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/source/hic_hal/uart.h	Tue Apr 07 12:55:42 2020 +0200
@@ -0,0 +1,94 @@
+/**
+ * @file    uart.h
+ * @brief
+ *
+ * DAPLink Interface Firmware
+ * Copyright (c) 2009-2016, ARM Limited, All Rights Reserved
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef UART_H
+#define UART_H
+
+#include <stdint.h>
+#include <stdbool.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/* Parity enumerator */
+typedef enum {
+    UART_PARITY_NONE    = 0,
+    UART_PARITY_ODD     = 1,
+    UART_PARITY_EVEN    = 2,
+    UART_PARITY_MARK    = 3,
+    UART_PARITY_SPACE   = 4
+} UART_Parity;
+
+/* Stop Bits enumerator */
+typedef enum {
+    UART_STOP_BITS_1    = 0,
+    UART_STOP_BITS_1_5  = 1,
+    UART_STOP_BITS_2    = 2
+} UART_StopBits;
+
+/* Data Bits enumerator */
+typedef enum {
+    UART_DATA_BITS_5    = 5,
+    UART_DATA_BITS_6    = 6,
+    UART_DATA_BITS_7    = 7,
+    UART_DATA_BITS_8    = 8,
+    UART_DATA_BITS_16   = 16
+} UART_DataBits;
+
+/* Flow control enumerator */
+typedef enum {
+    UART_FLOW_CONTROL_NONE     = 0,
+    UART_FLOW_CONTROL_RTS_CTS  = 1,
+    UART_FLOW_CONTROL_XON_XOFF = 2
+} UART_FlowControl;
+
+/* UART Port Properties structure */
+typedef struct {
+    uint32_t           Baudrate;
+    UART_DataBits      DataBits;
+    UART_Parity        Parity;
+    UART_StopBits      StopBits;
+    UART_FlowControl   FlowControl;
+} UART_Configuration;
+
+/*-----------------------------------------------------------------------------
+ * FUNCTION PROTOTYPES
+ *----------------------------------------------------------------------------*/
+
+/* UART driver function prototypes */
+extern int32_t uart_initialize(void);
+extern int32_t uart_uninitialize(void);
+extern int32_t uart_reset(void);
+extern int32_t uart_set_configuration(UART_Configuration *config);
+extern int32_t uart_get_configuration(UART_Configuration *config);
+extern int32_t uart_write_free(void);
+extern int32_t uart_write_data(uint8_t *data, uint16_t size);
+extern int32_t uart_read_data(uint8_t *data, uint16_t size);
+extern void uart_set_control_line_state(uint16_t ctrl_bmp);
+extern void uart_software_flow_control(void);
+extern void uart_enable_flow_control(bool enabled);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif