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.
306 Commits
10 Branches
7.2 MiB
 
 
 
 
 
Branch: unittest
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'unittest'
${ noResults }
WiringPi/wiringPi/wiringPi.h

317 lines
9.8 KiB
Raw Permalink 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  // deprecated since 3.2

  52. #define	WPI_MODE_PHYS		          3

  53. #define	WPI_MODE_PIFACE		        4

  54. #define	WPI_MODE_GPIO_DEVICE_BCM  5  // BCM pin numbers like WPI_MODE_GPIO

  55. #define	WPI_MODE_GPIO_DEVICE_WPI  6  // WiringPi pin numbers like WPI_MODE_PINS

  56. #define	WPI_MODE_GPIO_DEVICE_PHYS 7  // Physic pin numbers like WPI_MODE_PHYS

  57. #define	WPI_MODE_UNINITIALISED -1

  58. 

  59. // Pin modes

  60. 

  61. #define	INPUT			 0

  62. #define	OUTPUT			 1

  63. #define	PWM_OUTPUT		 2

  64. #define	GPIO_CLOCK		 3

  65. #define	SOFT_PWM_OUTPUT		 4

  66. #define	SOFT_TONE_OUTPUT	 5

  67. #define	PWM_TONE_OUTPUT		 6

  68. #define	PM_OFF		         7   // to input / release line

  69. 

  70. #define	LOW			 0

  71. #define	HIGH			 1

  72. 

  73. // Pull up/down/none

  74. 

  75. #define	PUD_OFF			 0

  76. #define	PUD_DOWN		 1

  77. #define	PUD_UP			 2

  78. 

  79. // PWM

  80. 

  81. #define	PWM_MODE_MS		0

  82. #define	PWM_MODE_BAL		1

  83. 

  84. // Interrupt levels

  85. 

  86. #define	INT_EDGE_SETUP		0

  87. #define	INT_EDGE_FALLING	1

  88. #define	INT_EDGE_RISING		2

  89. #define	INT_EDGE_BOTH		3

  90. 

  91. // Pi model types and version numbers

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

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

  94. 

  95. #define	PI_MODEL_A		 0

  96. #define	PI_MODEL_B		 1

  97. #define	PI_MODEL_AP		 2

  98. #define	PI_MODEL_BP		 3

  99. #define	PI_MODEL_2		 4

  100. #define	PI_ALPHA		 5

  101. #define	PI_MODEL_CM		 6

  102. #define	PI_MODEL_07		 7

  103. #define	PI_MODEL_3B		 8

  104. #define	PI_MODEL_ZERO		 9

  105. #define	PI_MODEL_CM3		10

  106. #define	PI_MODEL_ZERO_W		12

  107. #define	PI_MODEL_3BP 		13

  108. #define	PI_MODEL_3AP 		14

  109. #define	PI_MODEL_CM3P 		16

  110. #define	PI_MODEL_4B 		17

  111. #define	PI_MODEL_ZERO_2W	18

  112. #define	PI_MODEL_400		19

  113. #define	PI_MODEL_CM4		20

  114. #define	PI_MODEL_CM4S		21

  115. #define	PI_MODEL_5		  23

  116. 

  117. #define	PI_VERSION_1		0

  118. #define	PI_VERSION_1_1		1

  119. #define	PI_VERSION_1_2		2

  120. #define	PI_VERSION_2		3

  121. 

  122. #define	PI_MAKER_SONY		0

  123. #define	PI_MAKER_EGOMAN		1

  124. #define	PI_MAKER_EMBEST		2

  125. #define	PI_MAKER_UNKNOWN	3

  126. 

  127. #define GPIO_LAYOUT_PI1_REV1 1   //Pi 1 A/B Revision 1, 1.1, CM

  128. #define GPIO_LAYOUT_DEFAULT  2

  129. 

  130. extern const char *piModelNames    [24] ;

  131. extern const char *piProcessor     [ 5] ;

  132. extern const char *piRevisionNames [16] ;

  133. extern const char *piMakerNames    [16] ;

  134. extern const int   piMemorySize    [ 8] ;

  135. 

  136. 

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

  138. 

  139. // Threads

  140. 

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

  142. 

  143. // Failure modes

  144. 

  145. #define	WPI_FATAL	(1==1)

  146. #define	WPI_ALMOST	(1==2)

  147. 

  148. 

  149. // wiringPiNodeStruct:

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

  151. //	2.0 scheme of things.

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

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

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

  155. //	knows....

  156. 

  157. struct wiringPiNodeStruct

  158. {

  159.   int     pinBase ;

  160.   int     pinMax ;

  161. 

  162.   int          fd ;	// Node specific

  163.   unsigned int data0 ;	//  ditto

  164.   unsigned int data1 ;	//  ditto

  165.   unsigned int data2 ;	//  ditto

  166.   unsigned int data3 ;	//  ditto

  167. 

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

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

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

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

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

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

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

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

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

  177. 

  178.   struct wiringPiNodeStruct *next ;

  179. } ;

  180. 

  181. extern struct wiringPiNodeStruct *wiringPiNodes ;

  182. 

  183. // Export variables for the hardware pointers

  184. 

  185. extern volatile unsigned int *_wiringPiGpio ;

  186. extern volatile unsigned int *_wiringPiPwm ;

  187. extern volatile unsigned int *_wiringPiClk ;

  188. extern volatile unsigned int *_wiringPiPads ;

  189. extern volatile unsigned int *_wiringPiTimer ;

  190. extern volatile unsigned int *_wiringPiTimerIrqRaw ;

  191. 

  192. 

  193. // Function prototypes

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

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

  196. 

  197. #ifdef __cplusplus

  198. extern "C" {

  199. #endif

  200. 

  201. // Data

  202. 

  203. // Internal

  204. extern void piGpioLayoutOops (const char *why);

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

  206. 

  207. // Core wiringPi functions

  208. 

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

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

  211. 

  212. enum WPIPinType {

  213.   WPI_PIN_BCM = 1,

  214.   WPI_PIN_WPI,

  215.   WPI_PIN_PHYS,

  216. };

  217. 

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

  219. extern int  wiringPiGlobalMemoryAccess(void);                 //Interface V3.3

  220. extern int  wiringPiUserLevelAccess (void) ;

  221. extern int  wiringPiSetup       (void) ;

  222. extern int  wiringPiSetupSys    (void) ;

  223. extern int  wiringPiSetupGpio   (void) ;

  224. extern int  wiringPiSetupPhys   (void) ;

  225. extern int  wiringPiSetupPinType (enum WPIPinType pinType);   //Interface V3.3

  226. extern int  wiringPiSetupGpioDevice(enum WPIPinType pinType); //Interface V3.3

  227. 

  228. 

  229. enum WPIPinAlt {

  230.   WPI_ALT_UNKNOWN = -1,

  231.   WPI_ALT_INPUT = 0,

  232.   WPI_ALT_OUTPUT,

  233.   WPI_ALT5,

  234.   WPI_ALT4,

  235.   WPI_ALT0,

  236.   WPI_ALT1,

  237.   WPI_ALT2,

  238.   WPI_ALT3,

  239.   WPI_ALT6,

  240.   WPI_ALT7,

  241.   WPI_ALT8,

  242.   WPI_ALT9,

  243.   WPI_NONE = 0x1F,  // Pi5 default

  244. };

  245. 

  246. 

  247. extern          int  wiringPiGpioDeviceGetFd();               //Interface V3.3

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

  249. extern          enum WPIPinAlt getPinModeAlt       (int pin) ;  // Interface V3.5, same as getAlt but wie enum

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

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

  252. extern          int  digitalRead         (int pin) ;

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

  254. extern unsigned int  digitalRead8        (int pin) ;

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

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

  257. extern          int  analogRead          (int pin) ;

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

  259. 

  260. // PiFace specifics

  261. //	(Deprecated)

  262. 

  263. extern int  wiringPiSetupPiFace (void) ;

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

  265. 

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

  267. 

  268. extern          int  piGpioLayout        (void) ;

  269. extern          int  piBoardRev          (void) ;	// Deprecated, but does the same as piGpioLayout

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

  271. extern          int  piBoard40Pin        (void) ;                   // Interface V3.7

  272. extern          int  wpiPinToGpio        (int wpiPin) ;

  273. extern          int  physPinToGpio       (int physPin) ;

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

  275. extern          void setPadDrivePin      (int pin, int value);     // Interface V3.0

  276. extern          int  getAlt              (int pin) ;

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

  278. extern          void pwmSetMode          (int mode) ;

  279. extern          void pwmSetRange         (unsigned int range) ;

  280. extern          void pwmSetClock         (int divisor) ;

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

  282. extern unsigned int  digitalReadByte     (void) ;

  283. extern unsigned int  digitalReadByte2    (void) ;

  284. extern          void digitalWriteByte    (int value) ;

  285. extern          void digitalWriteByte2   (int value) ;

  286. 

  287. // Interrupts

  288. //	(Also Pi hardware specific)

  289. 

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

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

  292. extern int  wiringPiISRStop     (int pin) ;  //V3.2

  293. extern int  waitForInterruptClose(int pin) ; //V3.2

  294. 

  295. // Threads

  296. 

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

  298. extern void piLock              (int key) ;

  299. extern void piUnlock            (int key) ;

  300. 

  301. // Schedulling priority

  302. 

  303. extern int piHiPri (const int pri) ;

  304. 

  305. // Extras from arduino land

  306. 

  307. extern void         delay             (unsigned int howLong) ;

  308. extern void         delayMicroseconds (unsigned int howLong) ;

  309. extern unsigned int millis            (void) ;

  310. extern unsigned int micros            (void) ;

  311. 

  312. #ifdef __cplusplus

  313. }

  314. #endif

  315. 

  316. #endif