Gordons Projects

--> Projects Top-Level GIT

Minor changes to the files and removed a bit of debug.
[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 // Deprecated
30 #define NUM_PINS        17
31
32 #define WPI_MODE_PINS            0
33 #define WPI_MODE_GPIO            1
34 #define WPI_MODE_GPIO_SYS        2
35 #define WPI_MODE_PHYS            3
36 #define WPI_MODE_PIFACE          4
37 #define WPI_MODE_UNINITIALISED  -1
38
39 // Pin modes
40
41 #define INPUT                    0
42 #define OUTPUT                   1
43 #define PWM_OUTPUT               2
44 #define GPIO_CLOCK               3
45
46 #define LOW                      0
47 #define HIGH                     1
48
49 // Pull up/down/none
50
51 #define PUD_OFF                  0
52 #define PUD_DOWN                 1
53 #define PUD_UP                   2
54
55 // PWM
56
57 #define PWM_MODE_MS             0
58 #define PWM_MODE_BAL            1
59
60 // Interrupt levels
61
62 #define INT_EDGE_SETUP          0
63 #define INT_EDGE_FALLING        1
64 #define INT_EDGE_RISING         2
65 #define INT_EDGE_BOTH           3
66
67 // Threads
68
69 #define PI_THREAD(X)    void *X (void *dummy)
70
71 // Failure modes
72
73 #define WPI_FATAL       (1==1)
74 #define WPI_ALMOST      (1==2)
75
76
77 // wiringPiNodeStruct:
78 //      This describes additional device nodes in the extended wiringPi
79 //      2.0 scheme of things.
80 //      It's a simple linked list for now, but will hopefully migrate to 
81 //      a binary tree for efficiency reasons - but then again, the chances
82 //      of more than 1 or 2 devices being added are fairly slim, so who
83 //      knows....
84
85 struct wiringPiNodeStruct
86 {
87   int     pinBase ;
88   int     pinMax ;
89
90   int          fd ;     // Node specific
91   unsigned int data0 ;  //  ditto
92   unsigned int data1 ;  //  ditto
93   unsigned int data2 ;  //  ditto
94   unsigned int data3 ;  //  ditto
95
96   void   (*pinMode)         (struct wiringPiNodeStruct *node, int pin, int mode) ;
97   void   (*pullUpDnControl) (struct wiringPiNodeStruct *node, int pin, int mode) ;
98   int    (*digitalRead)     (struct wiringPiNodeStruct *node, int pin) ;
99   void   (*digitalWrite)    (struct wiringPiNodeStruct *node, int pin, int value) ;
100   void   (*pwmWrite)        (struct wiringPiNodeStruct *node, int pin, int value) ;
101   int    (*analogRead)      (struct wiringPiNodeStruct *node, int pin) ;
102   void   (*analogWrite)     (struct wiringPiNodeStruct *node, int pin, int value) ;
103
104   struct wiringPiNodeStruct *next ;
105 } ;
106
107 extern struct wiringPiNodeStruct *wiringPiNodes ;
108
109
110 // Function prototypes
111 //      c++ wrappers thanks to a comment by Nick Lott
112 //      (and others on the Raspberry Pi forums)
113
114 #ifdef __cplusplus
115 extern "C" {
116 #endif
117
118 // Internal
119
120 extern int wiringPiFailure (int fatal, const char *message, ...) ;
121
122 // Core wiringPi functions
123
124 extern struct wiringPiNodeStruct *wiringPiFindNode (int pin) ;
125 extern struct wiringPiNodeStruct *wiringPiNewNode  (int pinBase, int numPins) ;
126
127 extern int  wiringPiSetup       (void) ;
128 extern int  wiringPiSetupSys    (void) ;
129 extern int  wiringPiSetupGpio   (void) ;
130 extern int  wiringPiSetupPhys   (void) ;
131
132 extern void pinMode             (int pin, int mode) ;
133 extern void pullUpDnControl     (int pin, int pud) ;
134 extern int  digitalRead         (int pin) ;
135 extern void digitalWrite        (int pin, int value) ;
136 extern void pwmWrite            (int pin, int value) ;
137 extern int  analogRead          (int pin) ;
138 extern void analogWrite         (int pin, int value) ;
139
140 // PiFace specifics 
141 //      (Deprecated)
142
143 extern int  wiringPiSetupPiFace (void) ;
144 extern int  wiringPiSetupPiFaceForGpioProg (void) ;     // Don't use this - for gpio program only
145
146 // On-Board Raspberry Pi hardware specific stuff
147
148 extern int  piBoardRev          (void) ;
149 extern int  wpiPinToGpio        (int wpiPin) ;
150 extern int  physPinToGpio       (int physPin) ;
151 extern void setPadDrive         (int group, int value) ;
152 extern int  getAlt              (int pin) ;
153 extern void digitalWriteByte    (int value) ;
154 extern void pwmSetMode          (int mode) ;
155 extern void pwmSetRange         (unsigned int range) ;
156 extern void pwmSetClock         (int divisor) ;
157 extern void gpioClockSet        (int pin, int freq) ;
158
159 // Interrupts
160 //      (Also Pi hardware specific)
161
162 extern int  waitForInterrupt    (int pin, int mS) ;
163 extern int  wiringPiISR         (int pin, int mode, void (*function)(void)) ;
164
165 // Threads
166
167 extern int  piThreadCreate      (void *(*fn)(void *)) ;
168 extern void piLock              (int key) ;
169 extern void piUnlock            (int key) ;
170
171 // Schedulling priority
172
173 extern int piHiPri (const int pri) ;
174
175 // Extras from arduino land
176
177 extern void         delay             (unsigned int howLong) ;
178 extern void         delayMicroseconds (unsigned int howLong) ;
179 extern unsigned int millis            (void) ;
180 extern unsigned int micros            (void) ;
181
182 #ifdef __cplusplus
183 }
184 #endif
185
186 #endif