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
|
/*
ChibiOS/RT - Copyright (C) 2006-2007 Giovanni Di Sirio.
This file is part of ChibiOS/RT.
ChibiOS/RT is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
ChibiOS/RT is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @file ioports.h
* @brief I/O ports
* @addtogroup IOPorts
* @{
*/
#ifndef _IOPORTS_H_
#define _IOPORTS_H_
#ifndef _IOPORTS_LLD_H_
#include "ioports_lld.h"
#endif
/**
* @brief Port bit helper macro.
* @details This macro calculates the mask of a bit within a port.
*/
#define IOPORT_BIT(n) ((ioportmask_t)(1 << (n)))
/**
* @brief Port bus mask helper macro.
* @details This macro calculates the proper bus mask starting from the width
* and the offset.
*
* @param[in] width the width, in bits, of the I/O bus
* @param[in] offset the offset, within the port, of the I/O bus. The offset
* must be specified as offset from the least significant bit.
*/
#define IOPORT_BUS_MASK(width, offset) \
((ioportmask_t)(((1 << (width)) - 1) << (offset)))
/**
* @brief I/O bus descriptor.
* @details This structure describes a group of contiguous digital I/O lines
* that have to be handled as bus.
* @note I/O operations on a bus do not affect I/O lines on the same port but
* not belonging to the bus.
*/
typedef struct {
/** Port identifier. */
ioportid_t bus_portid;
/** Mask of the I/O lines that form the bus. The lines must be contiguous.
* The mask must be pre-shifted and also defines the bus width. */
ioportmask_t bus_mask;
/** Offset, within the port, of the least significant bit of the bus. */
uint_fast8_t bus_offset;
} IOBus;
/**
* @brief Writes a bits mask on a I/O port.
*
* @param[in] port the port identifier
* @param[in] bits the bits to be written on the specified port
*/
#define chPortWrite(port, bits) ioport_write_lld(port, bits)
/**
* @brief Reads an I/O port.
*
* @param[in] port the port identifier
* @return the port bits
*/
#define chPortRead(port) ioport_read_lld(port)
/**
* @brief Sets a bits mask on a I/O port.
*
* @param[in] port the port identifier
* @param[in] bits the bits to be ORed on the specified port
*
* @note The operation is not guaranteed to be atomic on all the architectures,
* for atomicity and/or portability reasons you may need to enclose port
* I/O operations between @p chSysLock() and @p chSysUnlock().
*/
#define chPortSet(port, bits) ioport_set_lld(port, bits)
/**
* @brief Clears a bits mask on a I/O port.
*
* @param[in] port the port identifier
* @param[in] bits the bits to be cleared on the specified port
*
* @note The operation is not guaranteed to be atomic on all the architectures,
* for atomicity and/or portability reasons you may need to enclose port
* I/O operations between @p chSysLock() and @p chSysUnlock().
*/
#define chPortClear(port, bits) ioport_clear_lld(port, bits)
/**
* @brief Toggles a bits mask on a I/O port.
*
* @param[in] port the port identifier
* @param[in] bits the bits to be XORed on the specified port
*
* @note The operation is not guaranteed to be atomic on all the architectures,
* for atomicity and/or portability reasons you may need to enclose port
* I/O operations between @p chSysLock() and @p chSysUnlock().
*/
#define chPortToggle(port, bits) ioport_toggle_lld(port, bits)
/**
* @brief Writes a value on an I/O bus.
*
* @param[in] bus the I/O bus, pointer to a @p IOBus structure
* @param[in] bits the bits to be written on the I/O bus. Values exceeding
* the bus width are masked so most significant bits are lost.
*
* @note The operation is not guaranteed to be atomic on all the architectures,
* for atomicity and/or portability reasons you may need to enclose port
* I/O operations between @p chSysLock() and @p chSysUnlock().
*/
#define chPortWriteBus(bus, bits) ioport_writebus_lld(bus, bits)
/**
* @brief Reads a value from an I/O bus.
*
* @param[in] bus the I/O bus, pointer to a @p IOBus structure
* @return the bus bits
*
* @note The operation is not guaranteed to be atomic on all the architectures,
* for atomicity and/or portability reasons you may need to enclose port
* I/O operations between @p chSysLock() and @p chSysUnlock().
*/
#define chPortReadBus(bus) ioport_readbus_lld(bus)
#endif /* _IOPORTS_H_ */
/** @} */
|
