Gordons Projects

--> Projects Top-Level GIT

Pushing to 2.39 as I have have not done the last one rightly...
[wiringPi] / wiringPi / wiringPi.h
1 /*
2  * wiringPi.h:
3  *      Arduino like Wiring library for the Raspberry Pi.
4  *      Copyright (c) 2012-2017 Gordon Henderson
5  ***********************************************************************
6  * This file is part of wiringPi:
7  *      https://projects.drogon.net/raspberry-pi/wiringpi/
8  *
9  *    wiringPi is free software: you can redistribute it and/or modify
10  *    it under the terms of the GNU Lesser General Public License as published by
11  *    the Free Software Foundation, either version 3 of the License, or
12  *    (at your option) any later version.
13  *
14  *    wiringPi is distributed in the hope that it will be useful,
15  *    but WITHOUT ANY WARRANTY; without even the implied warranty of
16  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  *    GNU Lesser General Public License for more details.
18  *
19  *    You should have received a copy of the GNU Lesser General Public License
20  *    along with wiringPi.  If not, see <http://www.gnu.org/licenses/>.
21  ***********************************************************************
22  */
23
24 #ifndef __WIRING_PI_H__
25 #define __WIRING_PI_H__
26
27 // C doesn't have true/false by default and I can never remember which
28 //      way round they are, so ...
29
30 #ifndef TRUE
31 #  define       TRUE    (1==1)
32 #  define       FALSE   (!TRUE)
33 #endif
34
35 // GCC warning suppressor
36
37 #define UNU     __attribute__((unused))
38
39 // Handy defines
40
41 // wiringPi modes
42
43 #define WPI_MODE_PINS            0
44 #define WPI_MODE_GPIO            1
45 #define WPI_MODE_GPIO_SYS        2
46 #define WPI_MODE_PHYS            3
47 #define WPI_MODE_PIFACE          4
48 #define WPI_MODE_UNINITIALISED  -1
49
50 // Pin modes
51
52 #define INPUT                    0
53 #define OUTPUT                   1
54 #define PWM_OUTPUT               2
55 #define GPIO_CLOCK               3
56 #define SOFT_PWM_OUTPUT          4
57 #define SOFT_TONE_OUTPUT         5
58 #define PWM_TONE_OUTPUT          6
59
60 #define LOW                      0
61 #define HIGH                     1
62
63 // Pull up/down/none
64
65 #define PUD_OFF                  0
66 #define PUD_DOWN                 1
67 #define PUD_UP                   2
68
69 // PWM
70
71 #define PWM_MODE_MS             0
72 #define PWM_MODE_BAL            1
73
74 // Interrupt levels
75
76 #define INT_EDGE_SETUP          0
77 #define INT_EDGE_FALLING        1
78 #define INT_EDGE_RISING         2
79 #define INT_EDGE_BOTH           3
80
81 // Pi model types and version numbers
82 //      Intended for the GPIO program Use at your own risk.
83
84 #define PI_MODEL_A               0
85 #define PI_MODEL_B               1
86 #define PI_MODEL_AP              2
87 #define PI_MODEL_BP              3
88 #define PI_MODEL_2               4
89 #define PI_ALPHA                 5
90 #define PI_MODEL_CM              6
91 #define PI_MODEL_07              7
92 #define PI_MODEL_3               8
93 #define PI_MODEL_ZERO            9
94 #define PI_MODEL_CM3            10
95
96 #define PI_VERSION_1            0
97 #define PI_VERSION_1_1          1
98 #define PI_VERSION_1_2          2
99 #define PI_VERSION_2            3
100
101 #define PI_MAKER_SONY           0
102 #define PI_MAKER_EGOMAN         1
103 #define PI_MAKER_EMBEST         2
104 #define PI_MAKER_UNKNOWN        3
105
106 extern const char *piModelNames    [16] ;
107 extern const char *piRevisionNames [16] ;
108 extern const char *piMakerNames    [16] ;
109 extern const int   piMemorySize    [ 8] ;
110
111
112 //      Intended for the GPIO program Use at your own risk.
113
114 // Threads
115
116 #define PI_THREAD(X)    void *X (UNU void *dummy)
117
118 // Failure modes
119
120 #define WPI_FATAL       (1==1)
121 #define WPI_ALMOST      (1==2)
122
123
124 // wiringPiNodeStruct:
125 //      This describes additional device nodes in the extended wiringPi
126 //      2.0 scheme of things.
127 //      It's a simple linked list for now, but will hopefully migrate to 
128 //      a binary tree for efficiency reasons - but then again, the chances
129 //      of more than 1 or 2 devices being added are fairly slim, so who
130 //      knows....
131
132 struct wiringPiNodeStruct
133 {
134   int     pinBase ;
135   int     pinMax ;
136
137   int          fd ;     // Node specific
138   unsigned int data0 ;  //  ditto
139   unsigned int data1 ;  //  ditto
140   unsigned int data2 ;  //  ditto
141   unsigned int data3 ;  //  ditto
142
143   void   (*pinMode)         (struct wiringPiNodeStruct *node, int pin, int mode) ;
144   void   (*pullUpDnControl) (struct wiringPiNodeStruct *node, int pin, int mode) ;
145   int    (*digitalRead)     (struct wiringPiNodeStruct *node, int pin) ;
146   void   (*digitalWrite)    (struct wiringPiNodeStruct *node, int pin, int value) ;
147   void   (*pwmWrite)        (struct wiringPiNodeStruct *node, int pin, int value) ;
148   int    (*analogRead)      (struct wiringPiNodeStruct *node, int pin) ;
149   void   (*analogWrite)     (struct wiringPiNodeStruct *node, int pin, int value) ;
150
151   struct wiringPiNodeStruct *next ;
152 } ;
153
154 extern struct wiringPiNodeStruct *wiringPiNodes ;
155
156
157 // Function prototypes
158 //      c++ wrappers thanks to a comment by Nick Lott
159 //      (and others on the Raspberry Pi forums)
160
161 #ifdef __cplusplus
162 extern "C" {
163 #endif
164
165 // Data
166
167 // Internal
168
169 extern int wiringPiFailure (int fatal, const char *message, ...) ;
170
171 // Core wiringPi functions
172
173 extern struct wiringPiNodeStruct *wiringPiFindNode (int pin) ;
174 extern struct wiringPiNodeStruct *wiringPiNewNode  (int pinBase, int numPins) ;
175
176 extern void wiringPiVersion     (int *major, int *minor) ;
177 extern int  wiringPiSetup       (void) ;
178 extern int  wiringPiSetupSys    (void) ;
179 extern int  wiringPiSetupGpio   (void) ;
180 extern int  wiringPiSetupPhys   (void) ;
181
182 extern void pinModeAlt          (int pin, int mode) ;
183 extern void pinMode             (int pin, int mode) ;
184 extern void pullUpDnControl     (int pin, int pud) ;
185 extern int  digitalRead         (int pin) ;
186 extern void digitalWrite        (int pin, int value) ;
187 extern void pwmWrite            (int pin, int value) ;
188 extern int  analogRead          (int pin) ;
189 extern void analogWrite         (int pin, int value) ;
190
191 // PiFace specifics 
192 //      (Deprecated)
193
194 extern int  wiringPiSetupPiFace (void) ;
195 extern int  wiringPiSetupPiFaceForGpioProg (void) ;     // Don't use this - for gpio program only
196
197 // On-Board Raspberry Pi hardware specific stuff
198
199 extern          int  piGpioLayout        (void) ;
200 extern          int  piBoardRev          (void) ;       // Deprecated
201 extern          void piBoardId           (int *model, int *rev, int *mem, int *maker, int *overVolted) ;
202 extern          int  wpiPinToGpio        (int wpiPin) ;
203 extern          int  physPinToGpio       (int physPin) ;
204 extern          void setPadDrive         (int group, int value) ;
205 extern          int  getAlt              (int pin) ;
206 extern          void pwmToneWrite        (int pin, int freq) ;
207 extern          void digitalWriteByte    (int value) ;
208 extern unsigned int  digitalReadByte     (void) ;
209 extern          void pwmSetMode          (int mode) ;
210 extern          void pwmSetRange         (unsigned int range) ;
211 extern          void pwmSetClock         (int divisor) ;
212 extern          void gpioClockSet        (int pin, int freq) ;
213
214 // Interrupts
215 //      (Also Pi hardware specific)
216
217 extern int  waitForInterrupt    (int pin, int mS) ;
218 extern int  wiringPiISR         (int pin, int mode, void (*function)(void)) ;
219
220 // Threads
221
222 extern int  piThreadCreate      (void *(*fn)(void *)) ;
223 extern void piLock              (int key) ;
224 extern void piUnlock            (int key) ;
225
226 // Schedulling priority
227
228 extern int piHiPri (const int pri) ;
229
230 // Extras from arduino land
231
232 extern void         delay             (unsigned int howLong) ;
233 extern void         delayMicroseconds (unsigned int howLong) ;
234 extern unsigned int millis            (void) ;
235 extern unsigned int micros            (void) ;
236
237 #ifdef __cplusplus
238 }
239 #endif
240
241 #endif