Gordons Projects

--> Projects Top-Level GIT

e09d06a1c90941cd1a7d4bb8108ef17466e04dad
[wiringPi] / wiringPi / wiringPi.h
1 /*
2  * wiringPi:
3  *      Arduino compatable (ish) Wiring library for the Raspberry Pi
4  *      Copyright (c) 2012 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 // Handy defines
28
29 // wiringPi modes
30
31 #define WPI_MODE_PINS            0
32 #define WPI_MODE_GPIO            1
33 #define WPI_MODE_GPIO_SYS        2
34 #define WPI_MODE_PHYS            3
35 #define WPI_MODE_PIFACE          4
36 #define WPI_MODE_UNINITIALISED  -1
37
38 // Pin modes
39
40 #define INPUT                    0
41 #define OUTPUT                   1
42 #define PWM_OUTPUT               2
43 #define GPIO_CLOCK               3
44 #define SOFT_PWM_OUTPUT          4
45 #define SOFT_TONE_OUTPUT         5
46 #define PWM_TONE_OUTPUT          6
47
48 #define LOW                      0
49 #define HIGH                     1
50
51 // Pull up/down/none
52
53 #define PUD_OFF                  0
54 #define PUD_DOWN                 1
55 #define PUD_UP                   2
56
57 // PWM
58
59 #define PWM_MODE_MS             0
60 #define PWM_MODE_BAL            1
61
62 // Interrupt levels
63
64 #define INT_EDGE_SETUP          0
65 #define INT_EDGE_FALLING        1
66 #define INT_EDGE_RISING         2
67 #define INT_EDGE_BOTH           3
68
69 // Pi model types and version numbers
70 //      Intended for the GPIO program Use at your own risk.
71
72 #define PI_MODEL_A              0
73 #define PI_MODEL_B              1
74 #define PI_MODEL_AP             2
75 #define PI_MODEL_BP             3
76 #define PI_MODEL_2              4
77 #define PI_ALPHA                5
78 #define PI_MODEL_CM             6
79
80 #define PI_VERSION_1            0
81 #define PI_VERSION_1_1          1
82 #define PI_VERSION_1_2          2
83 #define PI_VERSION_2            3
84
85 #define PI_MAKER_SONY           0
86 #define PI_MAKER_EGOMAN         1
87 #define PI_MAKER_MBEST          2
88 #define PI_MAKER_UNKNOWN        3
89
90 extern const char *piModelNames    [16] ;
91 extern const char *piRevisionNames [16] ;
92 extern const char *piMakerNames    [16] ;
93 extern const int   piMemorySize    [ 8] ;
94
95
96 //      Intended for the GPIO program Use at your own risk.
97
98 // Threads
99
100 #define PI_THREAD(X)    void *X (void *dummy)
101
102 // Failure modes
103
104 #define WPI_FATAL       (1==1)
105 #define WPI_ALMOST      (1==2)
106
107
108 // wiringPiNodeStruct:
109 //      This describes additional device nodes in the extended wiringPi
110 //      2.0 scheme of things.
111 //      It's a simple linked list for now, but will hopefully migrate to 
112 //      a binary tree for efficiency reasons - but then again, the chances
113 //      of more than 1 or 2 devices being added are fairly slim, so who
114 //      knows....
115
116 struct wiringPiNodeStruct
117 {
118   int     pinBase ;
119   int     pinMax ;
120
121   int          fd ;     // Node specific
122   unsigned int data0 ;  //  ditto
123   unsigned int data1 ;  //  ditto
124   unsigned int data2 ;  //  ditto
125   unsigned int data3 ;  //  ditto
126
127   void   (*pinMode)         (struct wiringPiNodeStruct *node, int pin, int mode) ;
128   void   (*pullUpDnControl) (struct wiringPiNodeStruct *node, int pin, int mode) ;
129   int    (*digitalRead)     (struct wiringPiNodeStruct *node, int pin) ;
130   void   (*digitalWrite)    (struct wiringPiNodeStruct *node, int pin, int value) ;
131   void   (*pwmWrite)        (struct wiringPiNodeStruct *node, int pin, int value) ;
132   int    (*analogRead)      (struct wiringPiNodeStruct *node, int pin) ;
133   void   (*analogWrite)     (struct wiringPiNodeStruct *node, int pin, int value) ;
134
135   struct wiringPiNodeStruct *next ;
136 } ;
137
138 extern struct wiringPiNodeStruct *wiringPiNodes ;
139
140
141 // Function prototypes
142 //      c++ wrappers thanks to a comment by Nick Lott
143 //      (and others on the Raspberry Pi forums)
144
145 #ifdef __cplusplus
146 extern "C" {
147 #endif
148
149 // Data
150
151 // Internal
152
153 extern int wiringPiFailure (int fatal, const char *message, ...) ;
154
155 // Core wiringPi functions
156
157 extern struct wiringPiNodeStruct *wiringPiFindNode (int pin) ;
158 extern struct wiringPiNodeStruct *wiringPiNewNode  (int pinBase, int numPins) ;
159
160 extern int  wiringPiSetup       (void) ;
161 extern int  wiringPiSetupSys    (void) ;
162 extern int  wiringPiSetupGpio   (void) ;
163 extern int  wiringPiSetupPhys   (void) ;
164
165 extern void pinModeAlt          (int pin, int mode) ;
166 extern void pinMode             (int pin, int mode) ;
167 extern void pullUpDnControl     (int pin, int pud) ;
168 extern int  digitalRead         (int pin) ;
169 extern void digitalWrite        (int pin, int value) ;
170 extern void pwmWrite            (int pin, int value) ;
171 extern int  analogRead          (int pin) ;
172 extern void analogWrite         (int pin, int value) ;
173
174 // PiFace specifics 
175 //      (Deprecated)
176
177 extern int  wiringPiSetupPiFace (void) ;
178 extern int  wiringPiSetupPiFaceForGpioProg (void) ;     // Don't use this - for gpio program only
179
180 // On-Board Raspberry Pi hardware specific stuff
181
182 extern int  piBoardRev          (void) ;
183 extern void piBoardId           (int *model, int *rev, int *mem, int *maker, int *overVolted) ;
184 extern int  wpiPinToGpio        (int wpiPin) ;
185 extern int  physPinToGpio       (int physPin) ;
186 extern void setPadDrive         (int group, int value) ;
187 extern int  getAlt              (int pin) ;
188 extern void pwmToneWrite        (int pin, int freq) ;
189 extern void digitalWriteByte    (int value) ;
190 extern void pwmSetMode          (int mode) ;
191 extern void pwmSetRange         (unsigned int range) ;
192 extern void pwmSetClock         (int divisor) ;
193 extern void gpioClockSet        (int pin, int freq) ;
194
195 // Interrupts
196 //      (Also Pi hardware specific)
197
198 extern int  waitForInterrupt    (int pin, int mS) ;
199 extern int  wiringPiISR         (int pin, int mode, void (*function)(void)) ;
200
201 // Threads
202
203 extern int  piThreadCreate      (void *(*fn)(void *)) ;
204 extern void piLock              (int key) ;
205 extern void piUnlock            (int key) ;
206
207 // Schedulling priority
208
209 extern int piHiPri (const int pri) ;
210
211 // Extras from arduino land
212
213 extern void         delay             (unsigned int howLong) ;
214 extern void         delayMicroseconds (unsigned int howLong) ;
215 extern unsigned int millis            (void) ;
216 extern unsigned int micros            (void) ;
217
218 #ifdef __cplusplus
219 }
220 #endif
221
222 #endif