tool/mbed/mbed-sdk/libraries/mbed/targets/cmsis/TARGET_Maxim/TARGET_MAX32600/uart_regs.h

   1 /*******************************************************************************
   2  * Copyright (C) 2015 Maxim Integrated Products, Inc., All Rights Reserved.
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice shall be included
  12  * in all copies or substantial portions of the Software.
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  15  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  16  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  17  * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
  18  * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  19  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  20  * OTHER DEALINGS IN THE SOFTWARE.
  21  *
  22  * Except as contained in this notice, the name of Maxim Integrated
  23  * Products, Inc. shall not be used except as stated in the Maxim Integrated
  24  * Products, Inc. Branding Policy.
  25  *
  26  * The mere transfer of this software does not imply any licenses
  27  * of trade secrets, proprietary technology, copyrights, patents,
  28  * trademarks, maskwork rights, or any other form of intellectual
  29  * property whatsoever. Maxim Integrated Products, Inc. retains all
  30  * ownership rights.
  31  *******************************************************************************
  32  */
  33
  34 #ifndef _MXC_UART_REGS_H_
  35 #define _MXC_UART_REGS_H_
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 #include <stdint.h>
  42
  43 /**
  44  * @file  uart_regs.h
  45  * @addtogroup uart UART
  46  * @{
  47  */
  48
  49 /*                                      Offset   Register Description
  50                                         ======   ============================================== */
  51 typedef struct {
  52     __IO uint32_t ctrl;             /*  0x0000   UART Control Register                          */
  53     __IO uint32_t status;           /*  0x0004   UART Status Register                           */
  54     __IO uint32_t inten;            /*  0x0008   Interrupt Enable/Disable Controls              */
  55     __IO uint32_t intfl;            /*  0x000C   Interrupt Flags                                */
  56     __IO uint32_t baud_int;         /*  0x0010   Baud Rate Setting (Integer Portion)            */
  57     __IO uint32_t baud_div_128;     /*  0x0014   Baud Rate Setting                              */
  58     __IO uint32_t tx_fifo_out;      /*  0x0018   TX FIFO Output End (read-only)                 */
  59     __IO uint32_t hw_flow_ctrl;     /*  0x001C   Hardware Flow Control Register                 */
  60     __IO uint32_t tx_rx_fifo;       /*  0x0020   Write to load TX FIFO, Read to unload RX FIFO  */
  61 } mxc_uart_regs_t;
  62
  63
  64 /*
  65     Register offsets for module UART.
  66 */
  67 #define MXC_R_UART_OFFS_CTRL                      ((uint32_t)0x00000000UL)
  68 #define MXC_R_UART_OFFS_STATUS                    ((uint32_t)0x00000004UL)
  69 #define MXC_R_UART_OFFS_INTEN                     ((uint32_t)0x00000008UL)
  70 #define MXC_R_UART_OFFS_INTFL                     ((uint32_t)0x0000000CUL)
  71 #define MXC_R_UART_OFFS_BAUD_INT                  ((uint32_t)0x00000010UL)
  72 #define MXC_R_UART_OFFS_BAUD_DIV_128              ((uint32_t)0x00000014UL)
  73 #define MXC_R_UART_OFFS_TX_FIFO_OUT               ((uint32_t)0x00000018UL)
  74 #define MXC_R_UART_OFFS_HW_FLOW_CTRL              ((uint32_t)0x0000001CUL)
  75 #define MXC_R_UART_OFFS_TX_RX_FIFO                ((uint32_t)0x00000020UL)
  76
  77 /*
  78    Field positions and masks for module UART.
  79 */
  80 #define MXC_F_UART_CTRL_RX_THRESHOLD_POS                    0
  81 #define MXC_F_UART_CTRL_RX_THRESHOLD                        ((uint32_t)(0x00000007UL << MXC_F_UART_CTRL_RX_THRESHOLD_POS))
  82 #define MXC_F_UART_CTRL_PARITY_ENABLE_POS                   4
  83 #define MXC_F_UART_CTRL_PARITY_ENABLE                       ((uint32_t)(0x00000001UL << MXC_F_UART_CTRL_PARITY_ENABLE_POS))
  84 #define MXC_F_UART_CTRL_PARITY_MODE_POS                     5
  85 #define MXC_F_UART_CTRL_PARITY_MODE                         ((uint32_t)(0x00000001UL << MXC_F_UART_CTRL_PARITY_MODE_POS))
  86 #define MXC_F_UART_CTRL_PARITY_BIAS_POS                     6
  87 #define MXC_F_UART_CTRL_PARITY_BIAS                         ((uint32_t)(0x00000001UL << MXC_F_UART_CTRL_PARITY_BIAS_POS))
  88 #define MXC_F_UART_CTRL_TX_FIFO_FLUSH_POS                   8
  89 #define MXC_F_UART_CTRL_TX_FIFO_FLUSH                       ((uint32_t)(0x00000001UL << MXC_F_UART_CTRL_TX_FIFO_FLUSH_POS))
  90 #define MXC_F_UART_CTRL_RX_FIFO_FLUSH_POS                   9
  91 #define MXC_F_UART_CTRL_RX_FIFO_FLUSH                       ((uint32_t)(0x00000001UL << MXC_F_UART_CTRL_RX_FIFO_FLUSH_POS))
  92 #define MXC_F_UART_CTRL_CHAR_LENGTH_POS                     10
  93 #define MXC_F_UART_CTRL_CHAR_LENGTH                         ((uint32_t)(0x00000003UL << MXC_F_UART_CTRL_CHAR_LENGTH_POS))
  94 #define MXC_F_UART_CTRL_STOP_BIT_MODE_POS                   12
  95 #define MXC_F_UART_CTRL_STOP_BIT_MODE                       ((uint32_t)(0x00000001UL << MXC_F_UART_CTRL_STOP_BIT_MODE_POS))
  96 #define MXC_F_UART_CTRL_HW_FLOW_CTRL_EN_POS                 13
  97 #define MXC_F_UART_CTRL_HW_FLOW_CTRL_EN                     ((uint32_t)(0x00000001UL << MXC_F_UART_CTRL_HW_FLOW_CTRL_EN_POS))
  98 #define MXC_F_UART_CTRL_BAUD_CLK_EN_POS                     14
  99 #define MXC_F_UART_CTRL_BAUD_CLK_EN                         ((uint32_t)(0x00000001UL << MXC_F_UART_CTRL_BAUD_CLK_EN_POS))
 100
 101 #define MXC_F_UART_STATUS_TX_BUSY_POS                       0
 102 #define MXC_F_UART_STATUS_TX_BUSY                           ((uint32_t)(0x00000001UL << MXC_F_UART_STATUS_TX_BUSY_POS))
 103 #define MXC_F_UART_STATUS_RX_BUSY_POS                       1
 104 #define MXC_F_UART_STATUS_RX_BUSY                           ((uint32_t)(0x00000001UL << MXC_F_UART_STATUS_RX_BUSY_POS))
 105 #define MXC_F_UART_STATUS_RX_FIFO_EMPTY_POS                 4
 106 #define MXC_F_UART_STATUS_RX_FIFO_EMPTY                     ((uint32_t)(0x00000001UL << MXC_F_UART_STATUS_RX_FIFO_EMPTY_POS))
 107 #define MXC_F_UART_STATUS_RX_FIFO_FULL_POS                  5
 108 #define MXC_F_UART_STATUS_RX_FIFO_FULL                      ((uint32_t)(0x00000001UL << MXC_F_UART_STATUS_RX_FIFO_FULL_POS))
 109 #define MXC_F_UART_STATUS_TX_FIFO_EMPTY_POS                 6
 110 #define MXC_F_UART_STATUS_TX_FIFO_EMPTY                     ((uint32_t)(0x00000001UL << MXC_F_UART_STATUS_TX_FIFO_EMPTY_POS))
 111 #define MXC_F_UART_STATUS_TX_FIFO_FULL_POS                  7
 112 #define MXC_F_UART_STATUS_TX_FIFO_FULL                      ((uint32_t)(0x00000001UL << MXC_F_UART_STATUS_TX_FIFO_FULL_POS))
 113 #define MXC_F_UART_STATUS_RX_FIFO_CHARS_POS                 8
 114 #define MXC_F_UART_STATUS_RX_FIFO_CHARS                     ((uint32_t)(0x0000000FUL << MXC_F_UART_STATUS_RX_FIFO_CHARS_POS))
 115 #define MXC_F_UART_STATUS_TX_FIFO_CHARS_POS                 12
 116 #define MXC_F_UART_STATUS_TX_FIFO_CHARS                     ((uint32_t)(0x0000000FUL << MXC_F_UART_STATUS_TX_FIFO_CHARS_POS))
 117
 118 #define MXC_F_UART_INTEN_RX_FRAME_ERROR_POS                 0
 119 #define MXC_F_UART_INTEN_RX_FRAME_ERROR                     ((uint32_t)(0x00000001UL << MXC_F_UART_INTEN_RX_FRAME_ERROR_POS))
 120 #define MXC_F_UART_INTEN_RX_PARITY_ERROR_POS                1
 121 #define MXC_F_UART_INTEN_RX_PARITY_ERROR                    ((uint32_t)(0x00000001UL << MXC_F_UART_INTEN_RX_PARITY_ERROR_POS))
 122 #define MXC_F_UART_INTEN_CTS_CHANGE_POS                     2
 123 #define MXC_F_UART_INTEN_CTS_CHANGE                         ((uint32_t)(0x00000001UL << MXC_F_UART_INTEN_CTS_CHANGE_POS))
 124 #define MXC_F_UART_INTEN_RX_OVERRUN_POS                     3
 125 #define MXC_F_UART_INTEN_RX_OVERRUN                         ((uint32_t)(0x00000001UL << MXC_F_UART_INTEN_RX_OVERRUN_POS))
 126 #define MXC_F_UART_INTEN_RX_OVER_THRESHOLD_POS              4
 127 #define MXC_F_UART_INTEN_RX_OVER_THRESHOLD                  ((uint32_t)(0x00000001UL << MXC_F_UART_INTEN_RX_OVER_THRESHOLD_POS))
 128 #define MXC_F_UART_INTEN_TX_ALMOST_EMPTY_POS                5
 129 #define MXC_F_UART_INTEN_TX_ALMOST_EMPTY                    ((uint32_t)(0x00000001UL << MXC_F_UART_INTEN_TX_ALMOST_EMPTY_POS))
 130 #define MXC_F_UART_INTEN_TX_HALF_EMPTY_POS                  6
 131 #define MXC_F_UART_INTEN_TX_HALF_EMPTY                      ((uint32_t)(0x00000001UL << MXC_F_UART_INTEN_TX_HALF_EMPTY_POS))
 132
 133 #define MXC_F_UART_INTFL_RX_FRAME_ERROR_POS                 0
 134 #define MXC_F_UART_INTFL_RX_FRAME_ERROR                     ((uint32_t)(0x00000001UL << MXC_F_UART_INTFL_RX_FRAME_ERROR_POS))
 135 #define MXC_F_UART_INTFL_RX_PARITY_ERROR_POS                1
 136 #define MXC_F_UART_INTFL_RX_PARITY_ERROR                    ((uint32_t)(0x00000001UL << MXC_F_UART_INTFL_RX_PARITY_ERROR_POS))
 137 #define MXC_F_UART_INTFL_CTS_CHANGE_POS                     2
 138 #define MXC_F_UART_INTFL_CTS_CHANGE                         ((uint32_t)(0x00000001UL << MXC_F_UART_INTFL_CTS_CHANGE_POS))
 139 #define MXC_F_UART_INTFL_RX_OVERRUN_POS                     3
 140 #define MXC_F_UART_INTFL_RX_OVERRUN                         ((uint32_t)(0x00000001UL << MXC_F_UART_INTFL_RX_OVERRUN_POS))
 141 #define MXC_F_UART_INTFL_RX_OVER_THRESHOLD_POS              4
 142 #define MXC_F_UART_INTFL_RX_OVER_THRESHOLD                  ((uint32_t)(0x00000001UL << MXC_F_UART_INTFL_RX_OVER_THRESHOLD_POS))
 143 #define MXC_F_UART_INTFL_TX_ALMOST_EMPTY_POS                5
 144 #define MXC_F_UART_INTFL_TX_ALMOST_EMPTY                    ((uint32_t)(0x00000001UL << MXC_F_UART_INTFL_TX_ALMOST_EMPTY_POS))
 145 #define MXC_F_UART_INTFL_TX_HALF_EMPTY_POS                  6
 146 #define MXC_F_UART_INTFL_TX_HALF_EMPTY                      ((uint32_t)(0x00000001UL << MXC_F_UART_INTFL_TX_HALF_EMPTY_POS))
 147
 148 #define MXC_F_UART_BAUD_INT_FBAUD_POS                       0
 149 #define MXC_F_UART_BAUD_INT_FBAUD                           ((uint32_t)(0x00000FFFUL << MXC_F_UART_BAUD_INT_FBAUD_POS))
 150
 151 #define MXC_F_UART_BAUD_DIV_128_DIV_POS                     0
 152 #define MXC_F_UART_BAUD_DIV_128_DIV                         ((uint32_t)(0x0000007FUL << MXC_F_UART_BAUD_DIV_128_DIV_POS))
 153
 154 #define MXC_F_UART_TX_FIFO_OUT_TX_FIFO_POS                  0
 155 #define MXC_F_UART_TX_FIFO_OUT_TX_FIFO                      ((uint32_t)(0x000000FFUL << MXC_F_UART_TX_FIFO_OUT_TX_FIFO_POS))
 156
 157 #define MXC_F_UART_HW_FLOW_CTRL_CTS_INPUT_POS               0
 158 #define MXC_F_UART_HW_FLOW_CTRL_CTS_INPUT                   ((uint32_t)(0x00000001UL << MXC_F_UART_HW_FLOW_CTRL_CTS_INPUT_POS))
 159 #define MXC_F_UART_HW_FLOW_CTRL_RTS_OUTPUT_POS              1
 160 #define MXC_F_UART_HW_FLOW_CTRL_RTS_OUTPUT                  ((uint32_t)(0x00000001UL << MXC_F_UART_HW_FLOW_CTRL_RTS_OUTPUT_POS))
 161
 162 #define MXC_F_UART_TX_RX_FIFO_FIFO_DATA_POS                 0
 163 #define MXC_F_UART_TX_RX_FIFO_FIFO_DATA                     ((uint32_t)(0x000000FFUL << MXC_F_UART_TX_RX_FIFO_FIFO_DATA_POS))
 164 #define MXC_F_UART_TX_RX_FIFO_PARITY_ERROR_POS              8
 165 #define MXC_F_UART_TX_RX_FIFO_PARITY_ERROR                  ((uint32_t)(0x00000001UL << MXC_F_UART_TX_RX_FIFO_PARITY_ERROR_POS))
 166
 167 #ifdef __cplusplus
 168 }
 169 #endif
 170
 171 /**
 172 * @}
 173 */
 174
 175 #endif /* _MXC_UART_REGS_H_ */