Gordons Projects

--> Projects Top-Level GIT

Lots of changes here. Added new I2C test code, a new serialTest program,
[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 // Handy defines
25
26 // Deprecated
27 #define NUM_PINS        17
28
29 #define WPI_MODE_PINS            0
30 #define WPI_MODE_GPIO            1
31 #define WPI_MODE_GPIO_SYS        2
32 #define WPI_MODE_PIFACE          3
33 #define WPI_MODE_UNINITIALISED  -1
34
35 #define INPUT                    0
36 #define OUTPUT                   1
37 #define PWM_OUTPUT               2
38
39 #define LOW                      0
40 #define HIGH                     1
41
42 #define PUD_OFF                  0
43 #define PUD_DOWN                 1
44 #define PUD_UP                   2
45
46 // PWM
47
48 #define PWM_MODE_MS             0
49 #define PWM_MODE_BAL            1
50
51 // Interrupt levels
52
53 #define INT_EDGE_SETUP          0
54 #define INT_EDGE_FALLING        1
55 #define INT_EDGE_RISING         2
56
57 // Threads
58
59 #define PI_THREAD(X)    void *X (void *dummy)
60
61
62 // Function prototypes
63 //      c++ wrappers thanks to a comment by Nick Lott
64 //      (and others on the Raspberry Pi forums)
65
66 #ifdef __cplusplus
67 extern "C" {
68 #endif
69
70 // Basic wiringPi functions
71
72 extern int  wiringPiSetup       (void) ;
73 extern int  wiringPiSetupSys    (void) ;
74 extern int  wiringPiSetupGpio   (void) ;
75 extern int  wiringPiSetupPiFace (void) ;
76
77 extern int  piBoardRev          (void) ;
78 extern int  wpiPinToGpio        (int wpiPin) ;
79
80 extern int  wiringPiSetupPiFaceForGpioProg (void) ;     // Don't use this - for gpio program only
81
82 extern void (*pinMode)           (int pin, int mode) ;
83 extern void (*pullUpDnControl)   (int pin, int pud) ;
84 extern void (*digitalWrite)      (int pin, int value) ;
85 extern void (*digitalWriteByte)  (int value) ;
86 extern void (*pwmWrite)          (int pin, int value) ;
87 extern void (*setPadDrive)       (int group, int value) ;
88 extern int  (*digitalRead)       (int pin) ;
89 extern void (*delayMicroseconds) (unsigned int howLong) ;
90 extern void (*pwmSetMode)        (int mode) ;
91 extern void (*pwmSetRange)       (unsigned int range) ;
92 extern void (*pwmSetClock)       (int divisor) ;
93
94 // Interrupts
95
96 extern int  (*waitForInterrupt) (int pin, int mS) ;
97 extern int  wiringPiISR         (int pin, int mode, void (*function)(void)) ;
98
99 // Threads
100
101 extern int  piThreadCreate (void *(*fn)(void *)) ;
102 extern void piLock         (int key) ;
103 extern void piUnlock       (int key) ;
104
105 // Schedulling priority
106
107 extern int piHiPri (int pri) ;
108
109
110 // Extras from arduino land
111
112 extern void         delay             (unsigned int howLong) ;
113 extern unsigned int millis            (void) ;
114
115 #ifdef __cplusplus
116 }
117 #endif