summaryrefslogtreecommitdiff
path: root/bsps/include/dev/grlib/apbuart.h
blob: 910cac2bb31090e8bfc34996101c30a8425d8382 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
/* SPDX-License-Identifier: BSD-2-Clause */

/**
 * @file
 *
 * @ingroup RTEMSDeviceGRLIB
 *
 * @brief This header file defines the APBUART register block interface.
 */

/*
 * Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

/*
 * This file is part of the RTEMS quality process and was automatically
 * generated.  If you find something that needs to be fixed or
 * worded better please post a report or patch to an RTEMS mailing list
 * or raise a bug report:
 *
 * https://www.rtems.org/bugs.html
 *
 * For information on updating and regenerating please refer to the How-To
 * section in the Software Requirements Engineering chapter of the
 * RTEMS Software Engineering manual.  The manual is provided as a part of
 * a release.  For development sources please refer to the online
 * documentation at:
 *
 * https://docs.rtems.org
 */

/* Generated from spec:/dev/grlib/if/apbuart-header */

#ifndef _DEV_GRLIB_APBUART_H
#define _DEV_GRLIB_APBUART_H

#ifdef __cplusplus
extern "C" {
#endif

/* Generated from spec:/dev/grlib/if/apbuart */

/**
 * @defgroup DevGrlibIfApbuart APBUART
 *
 * @ingroup RTEMSDeviceGRLIB
 *
 * @brief This group contains the APBUART interfaces.
 *
 * @{
 */

/**
 * @defgroup DevGrlibIfApbuartDATA DATA
 *
 * @brief UART data register
 *
 * @{
 */

#define APBUART_DATA_DATA_SHIFT 0
#define APBUART_DATA_DATA_MASK 0xffU
#define APBUART_DATA_DATA_GET( _reg ) \
  ( ( ( _reg ) >> 0 ) & 0xffU )
#define APBUART_DATA_DATA( _val ) ( ( _val ) << 0 )

/** @} */

/**
 * @defgroup DevGrlibIfApbuartSTATUS STATUS
 *
 * @brief UART status register
 *
 * @{
 */

#define APBUART_STATUS_RCNT_SHIFT 26
#define APBUART_STATUS_RCNT_MASK 0xfc000000U
#define APBUART_STATUS_RCNT_GET( _reg ) \
  ( ( ( _reg ) >> 26 ) & 0x3fU )
#define APBUART_STATUS_RCNT( _val ) ( ( _val ) << 26 )

#define APBUART_STATUS_TCNT_SHIFT 20
#define APBUART_STATUS_TCNT_MASK 0x3f00000U
#define APBUART_STATUS_TCNT_GET( _reg ) \
  ( ( ( _reg ) >> 20 ) & 0x3fU )
#define APBUART_STATUS_TCNT( _val ) ( ( _val ) << 20 )

#define APBUART_STATUS_RF 0x400U

#define APBUART_STATUS_TF 0x200U

#define APBUART_STATUS_RH 0x100U

#define APBUART_STATUS_TH 0x80U

#define APBUART_STATUS_FE 0x40U

#define APBUART_STATUS_PE 0x20U

#define APBUART_STATUS_OV 0x10U

#define APBUART_STATUS_BR 0x8U

#define APBUART_STATUS_TE 0x4U

#define APBUART_STATUS_TS 0x2U

#define APBUART_STATUS_DR 0x1U

/** @} */

/**
 * @defgroup DevGrlibIfApbuartCONTROL CONTROL
 *
 * @brief UART control register
 *
 * @{
 */

#define APBUART_CONTROL_FA 0x80000000U

#define APBUART_CONTROL_SI 0x4000U

#define APBUART_CONTROL_DI 0x2000U

#define APBUART_CONTROL_BI 0x1000U

#define APBUART_CONTROL_DB 0x800U

#define APBUART_CONTROL_RF 0x400U

#define APBUART_CONTROL_TF 0x200U

#define APBUART_CONTROL_EC 0x100U

#define APBUART_CONTROL_LB 0x80U

#define APBUART_CONTROL_FL 0x40U

#define APBUART_CONTROL_PE 0x20U

#define APBUART_CONTROL_PS 0x10U

#define APBUART_CONTROL_TI 0x8U

#define APBUART_CONTROL_RI 0x4U

#define APBUART_CONTROL_TE 0x2U

#define APBUART_CONTROL_RE 0x1U

/** @} */

/**
 * @defgroup DevGrlibIfApbuartSCALER SCALER
 *
 * @brief UART scaler reload register
 *
 * @{
 */

#define APBUART_SCALER_SCALER_RELOAD_VALUE_SHIFT 0
#define APBUART_SCALER_SCALER_RELOAD_VALUE_MASK 0xfffffU
#define APBUART_SCALER_SCALER_RELOAD_VALUE_GET( _reg ) \
  ( ( ( _reg ) >> 0 ) & 0xfffffU )
#define APBUART_SCALER_SCALER_RELOAD_VALUE( _val ) ( ( _val ) << 0 )

/** @} */

/**
 * @defgroup DevGrlibIfApbuartFIFO FIFO
 *
 * @brief UART FIFO debug register
 *
 * @{
 */

#define APBUART_FIFO_DATA_SHIFT 0
#define APBUART_FIFO_DATA_MASK 0xffU
#define APBUART_FIFO_DATA_GET( _reg ) \
  ( ( ( _reg ) >> 0 ) & 0xffU )
#define APBUART_FIFO_DATA( _val ) ( ( _val ) << 0 )

/** @} */

/**
 * @brief This structure defines the APBUART register block memory map.
 */
typedef struct {
  /**
   * @brief See @ref DevGrlibIfApbuartDATA.
   */
  uint32_t data;

  /**
   * @brief See @ref DevGrlibIfApbuartSTATUS.
   */
  uint32_t status;

  /**
   * @brief See @ref DevGrlibIfApbuartCONTROL.
   */
  uint32_t control;

  /**
   * @brief See @ref DevGrlibIfApbuartSCALER.
   */
  uint32_t scaler;

  /**
   * @brief See @ref DevGrlibIfApbuartFIFO.
   */
  uint32_t fifo;
} apbuart;

/** @} */

#ifdef __cplusplus
}
#endif

#endif /* _DEV_GRLIB_APBUART_H */