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

321 lines
10 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	PWM_MS_OUTPUT	     8

  65. #define	PWM_BAL_OUTPUT     9

  66. #define	GPIO_CLOCK		     3

  67. #define	SOFT_PWM_OUTPUT		 4

  68. #define	SOFT_TONE_OUTPUT	 5

  69. #define	PWM_TONE_OUTPUT		 6

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

  71. 

  72. #define	LOW			 0

  73. #define	HIGH			 1

  74. 

  75. // Pull up/down/none

  76. 

  77. #define	PUD_OFF			 0

  78. #define	PUD_DOWN		 1

  79. #define	PUD_UP			 2

  80. 

  81. // PWM

  82. 

  83. #define	PWM_MODE_MS		0

  84. #define	PWM_MODE_BAL		1

  85. 

  86. // Interrupt levels

  87. 

  88. #define	INT_EDGE_SETUP		0

  89. #define	INT_EDGE_FALLING	1

  90. #define	INT_EDGE_RISING		2

  91. #define	INT_EDGE_BOTH		3

  92. 

  93. // Pi model types and version numbers

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

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

  96. 

  97. #define	PI_MODEL_A		 0

  98. #define	PI_MODEL_B		 1

  99. #define	PI_MODEL_AP		 2

  100. #define	PI_MODEL_BP		 3

  101. #define	PI_MODEL_2		 4

  102. #define	PI_ALPHA		 5

  103. #define	PI_MODEL_CM		 6

  104. #define	PI_MODEL_07		 7

  105. #define	PI_MODEL_3B		 8

  106. #define	PI_MODEL_ZERO		 9

  107. #define	PI_MODEL_CM3		10

  108. #define	PI_MODEL_ZERO_W		12

  109. #define	PI_MODEL_3BP 		13

  110. #define	PI_MODEL_3AP 		14

  111. #define	PI_MODEL_CM3P 		16

  112. #define	PI_MODEL_4B 		17

  113. #define	PI_MODEL_ZERO_2W	18

  114. #define	PI_MODEL_400		19

  115. #define	PI_MODEL_CM4		20

  116. #define	PI_MODEL_CM4S		21

  117. #define	PI_MODEL_5		  23

  118. 

  119. #define	PI_VERSION_1		0

  120. #define	PI_VERSION_1_1		1

  121. #define	PI_VERSION_1_2		2

  122. #define	PI_VERSION_2		3

  123. 

  124. #define	PI_MAKER_SONY		0

  125. #define	PI_MAKER_EGOMAN		1

  126. #define	PI_MAKER_EMBEST		2

  127. #define	PI_MAKER_UNKNOWN	3

  128. 

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

  130. #define GPIO_LAYOUT_DEFAULT  2

  131. 

  132. extern const char *piModelNames    [24] ;

  133. extern const char *piProcessor     [ 5] ;

  134. extern const char *piRevisionNames [16] ;

  135. extern const char *piMakerNames    [16] ;

  136. extern const int   piMemorySize    [ 8] ;

  137. 

  138. 

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

  140. 

  141. // Threads

  142. 

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

  144. 

  145. // Failure modes

  146. 

  147. #define	WPI_FATAL	(1==1)

  148. #define	WPI_ALMOST	(1==2)

  149. 

  150. 

  151. // wiringPiNodeStruct:

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

  153. //	2.0 scheme of things.

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

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

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

  157. //	knows....

  158. 

  159. struct wiringPiNodeStruct

  160. {

  161.   int     pinBase ;

  162.   int     pinMax ;

  163. 

  164.   int          fd ;	// Node specific

  165.   unsigned int data0 ;	//  ditto

  166.   unsigned int data1 ;	//  ditto

  167.   unsigned int data2 ;	//  ditto

  168.   unsigned int data3 ;	//  ditto

  169. 

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

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

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

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

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

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

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

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

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

  179. 

  180.   struct wiringPiNodeStruct *next ;

  181. } ;

  182. 

  183. extern struct wiringPiNodeStruct *wiringPiNodes ;

  184. 

  185. // Export variables for the hardware pointers

  186. 

  187. extern volatile unsigned int *_wiringPiGpio ;

  188. extern volatile unsigned int *_wiringPiPwm ;

  189. extern volatile unsigned int *_wiringPiClk ;

  190. extern volatile unsigned int *_wiringPiPads ;

  191. extern volatile unsigned int *_wiringPiTimer ;

  192. extern volatile unsigned int *_wiringPiTimerIrqRaw ;

  193. 

  194. 

  195. // Function prototypes

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

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

  198. 

  199. #ifdef __cplusplus

  200. extern "C" {

  201. #endif

  202. 

  203. // Data

  204. 

  205. // Internal

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

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

  208. 

  209. // Core wiringPi functions

  210. 

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

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

  213. 

  214. enum WPIPinType {

  215.   WPI_PIN_BCM = 1,

  216.   WPI_PIN_WPI,

  217.   WPI_PIN_PHYS,

  218. };

  219. 

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

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

  222. extern int  wiringPiUserLevelAccess (void) ;

  223. extern int  wiringPiSetup       (void) ;

  224. extern int  wiringPiSetupSys    (void) ;

  225. extern int  wiringPiSetupGpio   (void) ;

  226. extern int  wiringPiSetupPhys   (void) ;

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

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

  229. 

  230. 

  231. enum WPIPinAlt {

  232.   WPI_ALT_UNKNOWN = -1,

  233.   WPI_ALT_INPUT = 0,

  234.   WPI_ALT_OUTPUT,

  235.   WPI_ALT5,

  236.   WPI_ALT4,

  237.   WPI_ALT0,

  238.   WPI_ALT1,

  239.   WPI_ALT2,

  240.   WPI_ALT3,

  241.   WPI_ALT6,

  242.   WPI_ALT7,

  243.   WPI_ALT8,

  244.   WPI_ALT9,

  245.   WPI_NONE = 0x1F,  // Pi5 default

  246. };

  247. 

  248. 

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

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

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

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

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

  254. extern          int  digitalRead         (int pin) ;

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

  256. extern unsigned int  digitalRead8        (int pin) ;

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

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

  259. extern          int  analogRead          (int pin) ;

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

  261. 

  262. // PiFace specifics

  263. //	(Deprecated)

  264. 

  265. extern int  wiringPiSetupPiFace (void) ;

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

  267. 

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

  269. 

  270. extern          int  piGpioLayout        (void) ;

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

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

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

  274. extern          int  wpiPinToGpio        (int wpiPin) ;

  275. extern          int  physPinToGpio       (int physPin) ;

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

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

  278. extern          int  getAlt              (int pin) ;

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

  280. extern          void pwmSetMode          (int mode) ;

  281. extern          void pwmSetRange         (unsigned int range) ;

  282. extern          void pwmSetClock         (int divisor) ;

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

  284. extern unsigned int  digitalReadByte     (void) ;

  285. extern unsigned int  digitalReadByte2    (void) ;

  286. extern          void digitalWriteByte    (int value) ;

  287. extern          void digitalWriteByte2   (int value) ;

  288. 

  289. // Interrupts

  290. //	(Also Pi hardware specific)

  291. 

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

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

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

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

  296. 

  297. // Threads

  298. 

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

  300. extern void piLock              (int key) ;

  301. extern void piUnlock            (int key) ;

  302. 

  303. // Schedulling priority

  304. 

  305. extern int piHiPri (const int pri) ;

  306. 

  307. // Extras from arduino land

  308. 

  309. extern void         delay             (unsigned int howLong) ;

  310. extern void         delayMicroseconds (unsigned int howLong) ;

  311. extern unsigned int millis            (void) ;

  312. extern unsigned int micros            (void) ;

  313. 

  314. extern unsigned long long piMicros64(void);   // Interface V3.7

  315. 

  316. #ifdef __cplusplus

  317. }

  318. #endif

  319. 

  320. #endif