wiringPi.h 8.1 KB

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