]> git.donarmstrong.com Git - qmk_firmware.git/blob - quantum/pincontrol.h
Improve RGB lighting documentation (#3580)
[qmk_firmware.git] / quantum / pincontrol.h
1 /* Copyright 2016 Wez Furlong
2  *
3  * This program is free software: you can redistribute it and/or modify
4  * it under the terms of the GNU General Public License as published by
5  * the Free Software Foundation, either version 2 of the License, or
6  * (at your option) any later version.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
15  */
16 #pragma once
17 // Some helpers for controlling gpio pins
18 #include <avr/io.h>
19
20 enum {
21   PinDirectionInput = 0,
22   PinDirectionOutput = 1,
23   PinLevelHigh = 1,
24   PinLevelLow = 0,
25 };
26
27 // ex: pinMode(B0, PinDirectionOutput);
28 static inline void pinMode(uint8_t pin, int mode) {
29   uint8_t bv = _BV(pin & 0xf);
30   if (mode == PinDirectionOutput) {
31     _SFR_IO8((pin >> 4) + 1) |= bv;
32   } else {
33     _SFR_IO8((pin >> 4) + 1) &= ~bv;
34     _SFR_IO8((pin >> 4) + 2) &= ~bv;
35   }
36 }
37
38 // ex: digitalWrite(B0, PinLevelHigh);
39 static inline void digitalWrite(uint8_t pin, int mode) {
40   uint8_t bv = _BV(pin & 0xf);
41   if (mode == PinLevelHigh) {
42     _SFR_IO8((pin >> 4) + 2) |= bv;
43   } else {
44     _SFR_IO8((pin >> 4) + 2) &= ~bv;
45   }
46 }
47
48 // Return true if the pin is HIGH
49 // digitalRead(B0)
50 static inline bool digitalRead(uint8_t pin) {
51   return _SFR_IO8(pin >> 4) & _BV(pin & 0xf);
52 }