heuzef
/
WiringPi
mirror of https://github.com/WiringPi/WiringPi.git
1
0
Fork 0
Code Issues 0 Releases 9 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
200 Commits
10 Branches
16 MiB
 
 
 
 
 
Tree: 76fb93fb43
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '76fb93fb43'
${ noResults }
WiringPi/wiringPi/wiringPi.h

278 lines
8.3 KiB
Raw Blame History 

  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://github.com/WiringPi/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. // C doesn't have true/false by default and I can never remember which

  28. //	way round they are, so ...

  29. //	(and yes, I know about stdbool.h but I like capitals for these and I'm old)

  30. 

  31. #ifndef	TRUE

  32. #  define	TRUE	(1==1)

  33. #  define	FALSE	(!TRUE)

  34. #endif

  35. 

  36. // GCC warning suppressor

  37. 

  38. #define	UNU	__attribute__((unused))

  39. 

  40. // Mask for the bottom 64 pins which belong to the Raspberry Pi

  41. //	The others are available for the other devices

  42. 

  43. #define	PI_GPIO_MASK	(0xFFFFFFC0)

  44. 

  45. // Handy defines

  46. 

  47. // wiringPi modes

  48. 

  49. #define	WPI_MODE_PINS		 0

  50. #define	WPI_MODE_GPIO		 1

  51. #define	WPI_MODE_GPIO_SYS	 2

  52. #define	WPI_MODE_PHYS		 3

  53. #define	WPI_MODE_PIFACE		 4

  54. #define	WPI_MODE_UNINITIALISED	-1

  55. 

  56. // Pin modes

  57. 

  58. #define	INPUT			 0

  59. #define	OUTPUT			 1

  60. #define	PWM_OUTPUT		 2

  61. #define	GPIO_CLOCK		 3

  62. #define	SOFT_PWM_OUTPUT		 4

  63. #define	SOFT_TONE_OUTPUT	 5

  64. #define	PWM_TONE_OUTPUT		 6

  65. 

  66. #define	LOW			 0

  67. #define	HIGH			 1

  68. 

  69. // Pull up/down/none

  70. 

  71. #define	PUD_OFF			 0

  72. #define	PUD_DOWN		 1

  73. #define	PUD_UP			 2

  74. 

  75. // PWM

  76. 

  77. #define	PWM_MODE_MS		0

  78. #define	PWM_MODE_BAL		1

  79. 

  80. // Interrupt levels

  81. 

  82. #define	INT_EDGE_SETUP		0

  83. #define	INT_EDGE_FALLING	1

  84. #define	INT_EDGE_RISING		2

  85. #define	INT_EDGE_BOTH		3

  86. 

  87. // Pi model types and version numbers

  88. //	Intended for the GPIO program Use at your own risk.

  89. // https://www.raspberrypi.com/documentation/computers/raspberry-pi.html#new-style-revision-codes

  90. 

  91. #define	PI_MODEL_A		 0

  92. #define	PI_MODEL_B		 1

  93. #define	PI_MODEL_AP		 2

  94. #define	PI_MODEL_BP		 3

  95. #define	PI_MODEL_2		 4

  96. #define	PI_ALPHA		 5

  97. #define	PI_MODEL_CM		 6

  98. #define	PI_MODEL_07		 7

  99. #define	PI_MODEL_3B		 8

  100. #define	PI_MODEL_ZERO		 9

  101. #define	PI_MODEL_CM3		10

  102. #define	PI_MODEL_ZERO_W		12

  103. #define	PI_MODEL_3BP 		13

  104. #define	PI_MODEL_3AP 		14

  105. #define	PI_MODEL_CM3P 		16

  106. #define	PI_MODEL_4B 		17

  107. #define	PI_MODEL_ZERO_2W	18

  108. #define	PI_MODEL_400		19

  109. #define	PI_MODEL_CM4		20

  110. #define	PI_MODEL_CM4S		21

  111. #define	PI_MODEL_5		  23

  112. 

  113. #define	PI_VERSION_1		0

  114. #define	PI_VERSION_1_1		1

  115. #define	PI_VERSION_1_2		2

  116. #define	PI_VERSION_2		3

  117. 

  118. #define	PI_MAKER_SONY		0

  119. #define	PI_MAKER_EGOMAN		1

  120. #define	PI_MAKER_EMBEST		2

  121. #define	PI_MAKER_UNKNOWN	3

  122. 

  123. 

  124. extern const char *piModelNames    [24] ;

  125. extern const char *piProcessor     [ 5] ;

  126. extern const char *piRevisionNames [16] ;

  127. extern const char *piMakerNames    [16] ;

  128. extern const int   piMemorySize    [ 8] ;

  129. 

  130. 

  131. //	Intended for the GPIO program Use at your own risk.

  132. 

  133. // Threads

  134. 

  135. #define	PI_THREAD(X)	void *X (UNU void *dummy)

  136. 

  137. // Failure modes

  138. 

  139. #define	WPI_FATAL	(1==1)

  140. #define	WPI_ALMOST	(1==2)

  141. 

  142. 

  143. // wiringPiNodeStruct:

  144. //	This describes additional device nodes in the extended wiringPi

  145. //	2.0 scheme of things.

  146. //	It's a simple linked list for now, but will hopefully migrate to

  147. //	a binary tree for efficiency reasons - but then again, the chances

  148. //	of more than 1 or 2 devices being added are fairly slim, so who

  149. //	knows....

  150. 

  151. struct wiringPiNodeStruct

  152. {

  153.   int     pinBase ;

  154.   int     pinMax ;

  155. 

  156.   int          fd ;	// Node specific

  157.   unsigned int data0 ;	//  ditto

  158.   unsigned int data1 ;	//  ditto

  159.   unsigned int data2 ;	//  ditto

  160.   unsigned int data3 ;	//  ditto

  161. 

  162.            void   (*pinMode)          (struct wiringPiNodeStruct *node, int pin, int mode) ;

  163.            void   (*pullUpDnControl)  (struct wiringPiNodeStruct *node, int pin, int mode) ;

  164.            int    (*digitalRead)      (struct wiringPiNodeStruct *node, int pin) ;

  165. //unsigned int    (*digitalRead8)     (struct wiringPiNodeStruct *node, int pin) ;

  166.            void   (*digitalWrite)     (struct wiringPiNodeStruct *node, int pin, int value) ;

  167. //         void   (*digitalWrite8)    (struct wiringPiNodeStruct *node, int pin, int value) ;

  168.            void   (*pwmWrite)         (struct wiringPiNodeStruct *node, int pin, int value) ;

  169.            int    (*analogRead)       (struct wiringPiNodeStruct *node, int pin) ;

  170.            void   (*analogWrite)      (struct wiringPiNodeStruct *node, int pin, int value) ;

  171. 

  172.   struct wiringPiNodeStruct *next ;

  173. } ;

  174. 

  175. extern struct wiringPiNodeStruct *wiringPiNodes ;

  176. 

  177. // Export variables for the hardware pointers

  178. 

  179. extern volatile unsigned int *_wiringPiGpio ;

  180. extern volatile unsigned int *_wiringPiPwm ;

  181. extern volatile unsigned int *_wiringPiClk ;

  182. extern volatile unsigned int *_wiringPiPads ;

  183. extern volatile unsigned int *_wiringPiTimer ;

  184. extern volatile unsigned int *_wiringPiTimerIrqRaw ;

  185. 

  186. 

  187. // Function prototypes

  188. //	c++ wrappers thanks to a comment by Nick Lott

  189. //	(and others on the Raspberry Pi forums)

  190. 

  191. #ifdef __cplusplus

  192. extern "C" {

  193. #endif

  194. 

  195. // Data

  196. 

  197. // Internal

  198. 

  199. extern int wiringPiFailure (int fatal, const char *message, ...) ;

  200. 

  201. // Core wiringPi functions

  202. 

  203. extern struct wiringPiNodeStruct *wiringPiFindNode (int pin) ;

  204. extern struct wiringPiNodeStruct *wiringPiNewNode  (int pinBase, int numPins) ;

  205. 

  206. extern int GPIOToSysFS(const int pin) ;

  207. 

  208. extern void wiringPiVersion	(int *major, int *minor) ;

  209. extern int  wiringPiSetup       (void) ;

  210. extern int  wiringPiSetupSys    (void) ;

  211. extern int  wiringPiSetupGpio   (void) ;

  212. extern int  wiringPiSetupPhys   (void) ;

  213. 

  214. extern          void pinModeAlt          (int pin, int mode) ;

  215. extern          void pinMode             (int pin, int mode) ;

  216. extern          void pullUpDnControl     (int pin, int pud) ;

  217. extern          int  digitalRead         (int pin) ;

  218. extern          void digitalWrite        (int pin, int value) ;

  219. extern unsigned int  digitalRead8        (int pin) ;

  220. extern          void digitalWrite8       (int pin, int value) ;

  221. extern          void pwmWrite            (int pin, int value) ;

  222. extern          int  analogRead          (int pin) ;

  223. extern          void analogWrite         (int pin, int value) ;

  224. 

  225. // PiFace specifics

  226. //	(Deprecated)

  227. 

  228. extern int  wiringPiSetupPiFace (void) ;

  229. extern int  wiringPiSetupPiFaceForGpioProg (void) ;	// Don't use this - for gpio program only

  230. 

  231. // On-Board Raspberry Pi hardware specific stuff

  232. 

  233. extern          int  piGpioLayout        (void) ;

  234. extern          int  piBoardRev          (void) ;	// Deprecated

  235. extern          void piBoardId           (int *model, int *rev, int *mem, int *maker, int *overVolted) ;

  236. extern          int  wpiPinToGpio        (int wpiPin) ;

  237. extern          int  physPinToGpio       (int physPin) ;

  238. extern          void setPadDrive         (int group, int value) ;

  239. extern          int  getAlt              (int pin) ;

  240. extern          void pwmToneWrite        (int pin, int freq) ;

  241. extern          void pwmSetMode          (int mode) ;

  242. extern          void pwmSetRange         (unsigned int range) ;

  243. extern          void pwmSetClock         (int divisor) ;

  244. extern          void gpioClockSet        (int pin, int freq) ;

  245. extern unsigned int  digitalReadByte     (void) ;

  246. extern unsigned int  digitalReadByte2    (void) ;

  247. extern          void digitalWriteByte    (int value) ;

  248. extern          void digitalWriteByte2   (int value) ;

  249. 

  250. // Interrupts

  251. //	(Also Pi hardware specific)

  252. 

  253. extern int  waitForInterrupt    (int pin, int mS) ;

  254. extern int  wiringPiISR         (int pin, int mode, void (*function)(void)) ;

  255. 

  256. // Threads

  257. 

  258. extern int  piThreadCreate      (void *(*fn)(void *)) ;

  259. extern void piLock              (int key) ;

  260. extern void piUnlock            (int key) ;

  261. 

  262. // Schedulling priority

  263. 

  264. extern int piHiPri (const int pri) ;

  265. 

  266. // Extras from arduino land

  267. 

  268. extern void         delay             (unsigned int howLong) ;

  269. extern void         delayMicroseconds (unsigned int howLong) ;

  270. extern unsigned int millis            (void) ;

  271. extern unsigned int micros            (void) ;

  272. 

  273. #ifdef __cplusplus

  274. }

  275. #endif

  276. 

  277. #endif