summaryrefslogtreecommitdiff
path: root/bsps/sparc/include/grlib/io.h
blob: 49fed6f682516281e2a91d2e5381ffd2107ccebb (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
/* SPDX-License-Identifier: BSD-2-Clause */

/**
 * @file
 *
 * @ingroup RTEMSDeviceGRLIBIO
 *
 * @brief This header file defines the register load/store 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:/bsp/sparc/if/grlib-io-header */

#ifndef _GRLIB_IO_H
#define _GRLIB_IO_H

#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif

/* Generated from spec:/bsp/sparc/if/grlib-io-group */

/**
 * @defgroup RTEMSDeviceGRLIBIO Register Load/Store
 *
 * @ingroup RTEMSDeviceGRLIB
 *
 * @brief This group contains the GRLIB register load/store API.
 */

/* Generated from spec:/bsp/sparc/if/grlib-load-08 */

/**
 * @ingroup RTEMSDeviceGRLIBIO
 *
 * @brief Loads the memory-mapped unsigned 8-bit register.
 *
 * @param address is the address of the memory-mapped unsigned 8-bit register
 *   to load.
 *
 * @return Returns the loaded register value.
 */
static inline uint8_t grlib_load_8( const volatile uint8_t *address )
{
  return *address;
}

/* Generated from spec:/bsp/sparc/if/grlib-load-16 */

/**
 * @ingroup RTEMSDeviceGRLIBIO
 *
 * @brief Loads the memory-mapped unsigned 16-bit register.
 *
 * @param address is the address of the memory-mapped unsigned 16-bit register
 *   to load.
 *
 * @return Returns the loaded register value.
 */
static inline uint16_t grlib_load_16( const volatile uint16_t *address )
{
  return *address;
}

/* Generated from spec:/bsp/sparc/if/grlib-load-32 */

/**
 * @ingroup RTEMSDeviceGRLIBIO
 *
 * @brief Loads the memory-mapped unsigned 32-bit register.
 *
 * @param address is the address of the memory-mapped unsigned 32-bit register
 *   to load.
 *
 * @return Returns the loaded register value.
 */
static inline uint32_t grlib_load_32( const volatile uint32_t *address )
{
  return *address;
}

/* Generated from spec:/bsp/sparc/if/grlib-load-64 */

/**
 * @ingroup RTEMSDeviceGRLIBIO
 *
 * @brief Loads the memory-mapped unsigned 64-bit register.
 *
 * @param address is the address of the memory-mapped unsigned 64-bit register
 *   to load.
 *
 * @return Returns the loaded register value.
 */
static inline uint64_t grlib_load_64( const volatile uint64_t *address )
{
  return *address;
}

/* Generated from spec:/bsp/sparc/if/grlib-store-08 */

/**
 * @ingroup RTEMSDeviceGRLIBIO
 *
 * @brief Stores the value to the memory-mapped unsigned 8-bit register.
 *
 * @param address is the address of the memory-mapped unsigned 8-bit register.
 *
 * @param value is the value to store.
 */
static inline void grlib_store_8( volatile uint8_t *address, uint8_t value )
{
  *address = value;
}

/* Generated from spec:/bsp/sparc/if/grlib-store-16 */

/**
 * @ingroup RTEMSDeviceGRLIBIO
 *
 * @brief Stores the value to the memory-mapped unsigned 16-bit register.
 *
 * @param address is the address of the memory-mapped unsigned 16-bit register.
 *
 * @param value is the value to store.
 */
static inline void grlib_store_16( volatile uint16_t *address, uint16_t value )
{
  *address = value;
}

/* Generated from spec:/bsp/sparc/if/grlib-store-32 */

/**
 * @ingroup RTEMSDeviceGRLIBIO
 *
 * @brief Stores the value to the memory-mapped unsigned 32-bit register.
 *
 * @param address is the address of the memory-mapped unsigned 32-bit register.
 *
 * @param value is the value to store.
 */
static inline void grlib_store_32( volatile uint32_t *address, uint32_t value )
{
  *address = value;
}

/* Generated from spec:/bsp/sparc/if/grlib-store-64 */

/**
 * @ingroup RTEMSDeviceGRLIBIO
 *
 * @brief Stores the value to the memory-mapped unsigned 64-bit register.
 *
 * @param address is the address of the memory-mapped unsigned 64-bit register.
 *
 * @param value is the value to store.
 */
static inline void grlib_store_64( volatile uint64_t *address, uint64_t value )
{
  *address = value;
}

#ifdef __cplusplus
}
#endif

#endif /* _GRLIB_IO_H */