wiringPi.h 8.2 KB

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