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
|
IO port
=======
And define: `CONFIG_IOE_IOPORT`
Defines simple access to io ports. This allows runtime access to any pin with just
serialized identifier.
Most of the functions has group and mask arguments. Group is letter, but in this
library is represented as number and exact number is defined as macro definition.
Mask is one shifted by index number(use \_BV macro). This way can be
addressed all IO ports. Exact identification consult with datasheet. You can also
use more than one index number and control more ports in single group with single
command.
WARNING: No check is implemented for right group number. Usage of unsupported
value is undefined (write to other parts of memory can happen).
Configuration
-------------
To use this part, you must enable `CONFIG_IOPORTS` option.
This part also handles pin change interrupts. Enable it using
`CONFIG_IOPORTS_PCINT` option.
References
----------
### For output
#### Function io_setout
```C
static inline void io_setout(uint8_t group, uint8_t mask)
```
Configures port of `group` with `mask` as output.
Parameters:
__group__ - Character specifying exact port group
__mask__ - Binary shifted 1. Shift is equal to port index in specified group.
#### Function io_high
```C
static inline void io_high(uint8_t group, uint8_t mask)
```
Sets output port to hight (also can be called as 1).
WARNING: Invoke this only if io_setout is called before.
Parameters:
__group__ - Character specifying exact port group
__mask__ - Binary shifted 1. Shift is equal to port index in specified group.
#### Function io_low
```C
static inline void io_low(uint8_t group, uint8_t mask)
```
Sets output port to low (also called as 0).
WARNING: Invoke this only if io_setout is called before.
Parameters:
__group__ - Number specifying exact port group
__mask__ - Binary shifted 1. Shift is equal to port index in specified group.
#### Function io_set
```C
static inline void io_set(uint8_t group, uint8_t mask, int8_t val)
```
Sets output port to value passed as argument.
WARNING: Invoke this only if io_setout is called before.
Parameters:
__group__ - Number specifying exact port group
__mask__ - Binary shifted 1. Shift is equal to port index in specified group.
### For input
#### Function io_setin
```C
static inline void io_setin(uint8_t group, uint8_t mask,
enum ioeIOInResistor resistor)
```
Configures port of `group` with `mask` as input with specified pull-up/down
resistor.
Parameters:
__group__ - Number specifying exact port group
__mask__ - Binary shifted 1. Shift is equal to port index in specified group.
#### Function io_get
```C
static inline int8_t io_get(uint8_t group, uint8_t mask)
```
Returns current value of port. Note that you can use this also if port is
configured as output.
Parameters:
__group__ - Number specifying exact port group
__mask__ - Binary shifted 1. Shift is equal to port index in specified group.
#### Enum ioeIOInResistor
```C
enum ioeIOInResistor {
IOE_IO_PULLUP,
IOE_IO_PULLDOWN
};
```
This enum is used as argument for io_setin. Names should be self explanatory
in this case.
### Pin change interrupts
#### Function io_change_sethook
```C
int8_t io_change_sethook(uint8_t group, uint8_t mask, uint8_t edge,
void (*change) (uint8_t group, uint8_t mask))
```
Registers function `change` as hook for pin change interrupt. `group` and `mask`
specifies port and edge specifies on what edge should hook be called. `edge` can
be IO_RISING or IO_FALLING or their binary combination with operator
`|`.
WARNING: `change` call is call during interrupt handling. You shouldn't be
blocking execution for long time.
Parameters:
__group__ - Number specifying exact port group.
__mask__ - Binary shifted 1. Shift is equal to port index in specified group.
__edge__ - Signals on what edge should be hook called.
__change__ - Pointer to function used as interupt hook.
#### Function io_change_remhook
```C
int8_t io_change_remhook(void (*change) (uint8_t group, uint8_t mask))
```
Removes `change` hook.
Parameters:
__change__ - Pointer to function used as hook
### Others
#### Definitions IO_{GROUP}
This defines exact numbers related to data-sheet groups. Always use these
definition not direct numbers, you can ensure cross MCU support this way.
#### Definitions IO_{GROUP}{INDEX}
Because specifying group and mask as separate parameters is not always optimal,
mcu support file should define all ports in form of single line definition in
format `IOE_IO_{GROUP}{INDEX}`. Disadvantage is that with these definitions you
can't use binary conjunction and so only one pin can be controlled with it.
Relevant examples
-----------------
* blink
* pcinterrupt
Adding support
--------------
For more information on how add support, see [Adding MCU support](/add_support.md).
Main definition is `MCUSUPPORT_IOPORT`. Define it to enable support.
### IO_{GROUP}
This should define any number that is handy for implementation of `IOE_IOE_PIN`,
`IOE_IO_DDR` and `IOE_IO_PORT`.
### IO_{PIN/DDR/PORT}
These should calculate exact pointers to register `PORT{GROUP}` for PORT variant
and likewise for others with group as argument. Common implementation would be
like this:
```C
#define IOE_IO_PIN(GROUP) (* (volatile uint8_t *)(PINB + 0x3*GROUP))
```
### IO_{GROUP}{INDEX}
This should be pair of group and one binary shifted to left relative to index.
### MCUSUPPORT_PCINT{NUM}
This defines that MCU supports specific pin change interrupt group. Also it
defines value that is number of pins in group.
|
