chiark / gitweb /
Fixed a bug in the gpio readall command on model B's (caused by a side-effect
[wiringPi.git] / wiringPi / wiringPi.h
index 03ab787c4cb5d7d42fd063217c743e62df706f7e..2bc63ba0146c1837e2d0e791655d09bebcf9e1d4 100644 (file)
  ***********************************************************************
  */
 
+#ifndef        __WIRING_PI_H__
+#define        __WIRING_PI_H__
+
 // Handy defines
 
+// Deprecated
 #define        NUM_PINS        17
 
 #define        WPI_MODE_PINS            0
 #define        WPI_MODE_GPIO            1
 #define        WPI_MODE_GPIO_SYS        2
-#define        WPI_MODE_PIFACE          3
+#define        WPI_MODE_PHYS            3
+#define        WPI_MODE_PIFACE          4
+#define        WPI_MODE_UNINITIALISED  -1
+
+// Pin modes
+
+#define        INPUT                    0
+#define        OUTPUT                   1
+#define        PWM_OUTPUT               2
+#define        GPIO_CLOCK               3
+#define        SOFT_PWM_OUTPUT          4
+#define        SOFT_TONE_OUTPUT         5
+#define        PWM_TONE_OUTPUT          6
+
+#define        LOW                      0
+#define        HIGH                     1
+
+// Pull up/down/none
+
+#define        PUD_OFF                  0
+#define        PUD_DOWN                 1
+#define        PUD_UP                   2
+
+// PWM
+
+#define        PWM_MODE_MS             0
+#define        PWM_MODE_BAL            1
+
+// Interrupt levels
+
+#define        INT_EDGE_SETUP          0
+#define        INT_EDGE_FALLING        1
+#define        INT_EDGE_RISING         2
+#define        INT_EDGE_BOTH           3
+
+// Pi model types and version numbers
+//     Intended for the GPIO program Use at your own risk.
+
+#define        PI_MODEL_UNKNOWN        0
+#define        PI_MODEL_A              1
+#define        PI_MODEL_B              2
+#define        PI_MODEL_BP             3
+#define        PI_MODEL_CM             4
+
+#define        PI_VERSION_UNKNOWN      0
+#define        PI_VERSION_1            1
+#define        PI_VERSION_1_1          2
+#define        PI_VERSION_1_2          3
+#define        PI_VERSION_2            4
+
+#define        PI_MAKER_UNKNOWN        0
+#define        PI_MAKER_EGOMAN         1
+#define        PI_MAKER_SONY           2
+#define        PI_MAKER_QISDA          3
+
+extern const char *piModelNames    [5] ;
+extern const char *piRevisionNames [5] ;
+extern const char *piMakerNames    [4] ;
+
+
+//     Intended for the GPIO program Use at your own risk.
+
+// Threads
+
+#define        PI_THREAD(X)    void *X (void *dummy)
 
-#define        INPUT            0
-#define        OUTPUT           1
-#define        PWM_OUTPUT       2
+// Failure modes
 
-#define        LOW              0
-#define        HIGH             1
+#define        WPI_FATAL       (1==1)
+#define        WPI_ALMOST      (1==2)
+
+
+// wiringPiNodeStruct:
+//     This describes additional device nodes in the extended wiringPi
+//     2.0 scheme of things.
+//     It's a simple linked list for now, but will hopefully migrate to 
+//     a binary tree for efficiency reasons - but then again, the chances
+//     of more than 1 or 2 devices being added are fairly slim, so who
+//     knows....
+
+struct wiringPiNodeStruct
+{
+  int     pinBase ;
+  int     pinMax ;
+
+  int          fd ;    // Node specific
+  unsigned int data0 ; //  ditto
+  unsigned int data1 ; //  ditto
+  unsigned int data2 ; //  ditto
+  unsigned int data3 ; //  ditto
+
+  void   (*pinMode)         (struct wiringPiNodeStruct *node, int pin, int mode) ;
+  void   (*pullUpDnControl) (struct wiringPiNodeStruct *node, int pin, int mode) ;
+  int    (*digitalRead)     (struct wiringPiNodeStruct *node, int pin) ;
+  void   (*digitalWrite)    (struct wiringPiNodeStruct *node, int pin, int value) ;
+  void   (*pwmWrite)        (struct wiringPiNodeStruct *node, int pin, int value) ;
+  int    (*analogRead)      (struct wiringPiNodeStruct *node, int pin) ;
+  void   (*analogWrite)     (struct wiringPiNodeStruct *node, int pin, int value) ;
+
+  struct wiringPiNodeStruct *next ;
+} ;
+
+extern struct wiringPiNodeStruct *wiringPiNodes ;
 
-#define        PUD_OFF          0
-#define        PUD_DOWN         1
-#define        PUD_UP           2
 
 // Function prototypes
-//     c++ wrappers thanks to a commend by Nick Lott
+//     c++ wrappers thanks to a comment by Nick Lott
 //     (and others on the Raspberry Pi forums)
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-// Basic wiringPi functions
+// Data
+
+//extern const char *piModelNames [] ;
+//extern const char *piRevisionNames[] ;
+
+// Internal
+
+extern int wiringPiFailure (int fatal, const char *message, ...) ;
+
+// Core wiringPi functions
+
+extern struct wiringPiNodeStruct *wiringPiFindNode (int pin) ;
+extern struct wiringPiNodeStruct *wiringPiNewNode  (int pinBase, int numPins) ;
 
 extern int  wiringPiSetup       (void) ;
 extern int  wiringPiSetupSys    (void) ;
 extern int  wiringPiSetupGpio   (void) ;
-extern int  wiringPiSetupPiFace (void) ;
+extern int  wiringPiSetupPhys   (void) ;
+
+extern void pinModeAlt          (int pin, int mode) ;
+extern void pinMode             (int pin, int mode) ;
+extern void pullUpDnControl     (int pin, int pud) ;
+extern int  digitalRead         (int pin) ;
+extern void digitalWrite        (int pin, int value) ;
+extern void pwmWrite            (int pin, int value) ;
+extern int  analogRead          (int pin) ;
+extern void analogWrite         (int pin, int value) ;
 
+// PiFace specifics 
+//     (Deprecated)
+
+extern int  wiringPiSetupPiFace (void) ;
 extern int  wiringPiSetupPiFaceForGpioProg (void) ;    // Don't use this - for gpio program only
 
-extern void (*pinMode)           (int pin, int mode) ;
-extern void (*pullUpDnControl)   (int pin, int pud) ;
-extern void (*digitalWrite)      (int pin, int value) ;
-extern void (*pwmWrite)          (int pin, int value) ;
-extern void (*setPadDrive)       (int group, int value) ;
-extern int  (*digitalRead)       (int pin) ;
-extern void (*delayMicroseconds) (unsigned int howLong) ;
+// On-Board Raspberry Pi hardware specific stuff
+
+extern int  piBoardRev          (void) ;
+extern void piBoardId           (int *model, int *rev, int *mem, int *maker, int *overVolted) ;
+extern int  wpiPinToGpio        (int wpiPin) ;
+extern int  physPinToGpio       (int physPin) ;
+extern void setPadDrive         (int group, int value) ;
+extern int  getAlt              (int pin) ;
+extern void pwmToneWrite        (int pin, int freq) ;
+extern void digitalWriteByte    (int value) ;
+extern void pwmSetMode          (int mode) ;
+extern void pwmSetRange         (unsigned int range) ;
+extern void pwmSetClock         (int divisor) ;
+extern void gpioClockSet        (int pin, int freq) ;
 
 // Interrupts
+//     (Also Pi hardware specific)
 
-extern int  (*waitForInterrupt) (int pin, int mS) ;
+extern int  waitForInterrupt    (int pin, int mS) ;
+extern int  wiringPiISR         (int pin, int mode, void (*function)(void)) ;
 
 // Threads
 
-#define        PI_THREAD(X)    void *X (void *dummy)
-
-extern int  piThreadCreate (void *(*fn)(void *)) ;
-extern void piLock         (int key) ;
-extern void piUnlock       (int key) ;
+extern int  piThreadCreate      (void *(*fn)(void *)) ;
+extern void piLock              (int key) ;
+extern void piUnlock            (int key) ;
 
 // Schedulling priority
 
-extern int piHiPri (int pri) ;
-
+extern int piHiPri (const int pri) ;
 
 // Extras from arduino land
 
 extern void         delay             (unsigned int howLong) ;
+extern void         delayMicroseconds (unsigned int howLong) ;
 extern unsigned int millis            (void) ;
+extern unsigned int micros            (void) ;
 
 #ifdef __cplusplus
 }
 #endif
+
+#endif