Files
wiringPi/wiringPi/wiringPi.h
2019-07-16 18:08:16 +09:00

309 lines
9.3 KiB
C
Executable File

/*
* wiringPi.h:
* Arduino like Wiring library for the Raspberry Pi.
* Copyright (c) 2012-2017 Gordon Henderson
***********************************************************************
* This file is part of wiringPi:
* https://projects.drogon.net/raspberry-pi/wiringpi/
*
* wiringPi is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* wiringPi is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with wiringPi. If not, see <http://www.gnu.org/licenses/>.
***********************************************************************
*/
/*----------------------------------------------------------------------------*/
#ifndef __WIRING_H__
#define __WIRING_H__
/*----------------------------------------------------------------------------*/
#include <stdio.h>
#include <stdarg.h>
#include <stdint.h>
#include <stdlib.h>
/*----------------------------------------------------------------------------*/
#ifndef TRUE
#define TRUE (1==1)
#define FALSE (!TRUE)
#endif
#define PIN_NUM_CALC_SYSFD(X) (X > 255 ? X - libwiring.pinBase : X)
#define UNU __attribute__((unused))
#define ENV_DEBUG "WIRINGPI_DEBUG"
#define ENV_CODES "WIRINGPI_CODES"
#define ENV_GPIOMEM "WIRINGPI_GPIOMEM"
#define MODEL_UNKNOWN 0
#define MODEL_ODROID_C1 1
#define MODEL_ODROID_C2 2
#define MODEL_ODROID_XU3 3
#define MODEL_ODROID_N1 4
#define MODEL_ODROID_N2 5
#define MAKER_UNKNOWN 0
#define MAKER_AMLOGIC 1
#define MAKER_SAMSUNG 2
#define MAKER_ROCKCHIP 3
#define MODE_PINS 0
#define MODE_GPIO 1
#define MODE_GPIO_SYS 2
#define MODE_PHYS 3
#define MODE_PIFACE 4
#define MODE_UNINITIALISED -1
// Pin modes
#define INPUT 0
#define OUTPUT 1
#define PWM_OUTPUT 2
#define GPIO_CLOCK 3
#define SOFT_PWM_OUTPUT 4
#define SOFT_TONE_OUTPUT 5
#define PWM_TONE_OUTPUT 6
#define LOW 0
#define HIGH 1
// Pull up/down/none
#define PUD_OFF 0
#define PUD_DOWN 1
#define PUD_UP 2
// Interrupt levels
#define INT_EDGE_SETUP 0
#define INT_EDGE_FALLING 1
#define INT_EDGE_RISING 2
#define INT_EDGE_BOTH 3
// Module names
#define AML_MODULE_I2C "aml_i2c"
// Threads
#define PI_THREAD(X) void *X (UNU void *dummy)
// Failure modes
#define WPI_FATAL (1==1)
#define WPI_ALMOST (1==2)
extern const char *piModelNames [16];
extern const char *piRevisionNames [16];
extern const char *piMakerNames [16];
extern const int piMemorySize [ 8];
/*----------------------------------------------------------------------------*/
#if !defined(ANDROID)
#define PAGE_SIZE (4*1024)
#endif
#define BLOCK_SIZE (4*1024)
/*----------------------------------------------------------------------------*/
/* Debug message display function */
/*----------------------------------------------------------------------------*/
#define MSG_ERR -1
#define MSG_WARN -2
/*----------------------------------------------------------------------------*/
struct libodroid
{
/* H/W model info */
int model, rev, mem, maker;
/* wiringPi init Mode */
int mode;
/* wiringPi core func */
int (*getModeToGpio) (int mode, int pin);
int (*setPadDrive) (int pin, int value);
int (*getPadDrive) (int pin);
int (*pinMode) (int pin, int mode);
int (*getAlt) (int pin);
int (*getPUPD) (int pin);
int (*pullUpDnControl) (int pin, int pud);
int (*digitalRead) (int pin);
int (*digitalWrite) (int pin, int value);
int (*analogRead) (int pin);
int (*digitalWriteByte) (const unsigned int value);
unsigned int (*digitalReadByte) (void);
/* ISR Function pointer */
void (*isrFunctions[256])(void);
/* GPIO sysfs file discripter */
int sysFds[256];
/* GPIO pin base number */
int pinBase;
// Time for easy calculations
uint64_t epochMilli, epochMicro ;
};
union reg_bitfield {
unsigned int wvalue;
struct {
unsigned int bit0 : 1;
unsigned int bit1 : 1;
unsigned int bit2 : 1;
unsigned int bit3 : 1;
unsigned int bit4 : 1;
unsigned int bit5 : 1;
unsigned int bit6 : 1;
unsigned int bit7 : 1;
unsigned int bit8 : 1;
unsigned int bit9 : 1;
unsigned int bit10 : 1;
unsigned int bit11 : 1;
unsigned int bit12 : 1;
unsigned int bit13 : 1;
unsigned int bit14 : 1;
unsigned int bit15 : 1;
unsigned int bit16 : 1;
unsigned int bit17 : 1;
unsigned int bit18 : 1;
unsigned int bit19 : 1;
unsigned int bit20 : 1;
unsigned int bit21 : 1;
unsigned int bit22 : 1;
unsigned int bit23 : 1;
unsigned int bit24 : 1;
unsigned int bit25 : 1;
unsigned int bit26 : 1;
unsigned int bit27 : 1;
unsigned int bit28 : 1;
unsigned int bit29 : 1;
unsigned int bit30 : 1;
unsigned int bit31 : 1;
} bits;
};
/*----------------------------------------------------------------------------*/
// wiringPiNodeStruct:
// This describes additional device nodes in the extended wiringPi
// 2.0 scheme of things.
// It's a simple linked list for now, but will hopefully migrate to
// a binary tree for efficiency reasons - but then again, the chances
// of more than 1 or 2 devices being added are fairly slim, so who
// knows....
/*----------------------------------------------------------------------------*/
struct wiringPiNodeStruct
{
int pinBase;
int pinMax;
int fd; // Node specific
unsigned int data0; // ditto
unsigned int data1; // ditto
unsigned int data2; // ditto
unsigned int data3; // ditto
void (*pinMode) (struct wiringPiNodeStruct *node, int pin, int mode);
void (*pullUpDnControl) (struct wiringPiNodeStruct *node, int pin, int mode);
int (*digitalRead) (struct wiringPiNodeStruct *node, int pin);
// unsigned int (*digitalRead8) (struct wiringPiNodeStruct *node, int pin);
void (*digitalWrite) (struct wiringPiNodeStruct *node, int pin, int value);
// void (*digitalWrite8) (struct wiringPiNodeStruct *node, int pin, int value);
void (*pwmWrite) (struct wiringPiNodeStruct *node, int pin, int value);
int (*analogRead) (struct wiringPiNodeStruct *node, int pin);
void (*analogWrite) (struct wiringPiNodeStruct *node, int pin, int value);
struct wiringPiNodeStruct *next;
};
extern struct wiringPiNodeStruct *wiringPiNodes;
/*----------------------------------------------------------------------------*/
// Function prototypes
// c++ wrappers thanks to a comment by Nick Lott
// (and others on the Raspberry Pi forums)
/*----------------------------------------------------------------------------*/
#ifdef __cplusplus
extern "C" {
#endif
extern struct wiringPiNodeStruct *wiringPiFindNode (int pin);
extern struct wiringPiNodeStruct *wiringPiNewNode (int pinBase, int numPins);
// Internal WiringPi functions
extern int wiringPiFailure (int fatal, const char *message, ...);
extern int msg (int type, const char *message, ...);
extern int moduleLoaded (char *);
// Core WiringPi functions
extern void wiringPiVersion (int *major, char **minor);
extern int wiringPiSetup (void);
extern int wiringPiSetupSys (void);
extern int wiringPiSetupGpio (void);
extern int wiringPiSetupPhys (void);
extern void setPadDrive (int pin, int value);
extern int getPadDrive (int pin);
extern int getAlt (int pin);
extern int getPUPD (int pin);
extern void pinMode (int pin, int mode);
extern void pullUpDnControl (int pin, int pud);
extern int digitalRead (int pin);
extern void digitalWrite (int pin, int value);
extern unsigned int digitalReadByte (void);
extern void digitalWriteByte (const int value);
extern void pwmWrite (int pin, int value);
extern int analogRead (int pin);
// Hardware specific stuffs
extern int piGpioLayout (void);
extern int piBoardRev (void); // Deprecated
extern void piBoardId (int *model, int *rev, int *mem, int *maker, int *warranty);
extern int wpiPinToGpio (int wpiPin);
extern int physPinToGpio (int physPin);
// Unsupported
extern void pinModeAlt (int pin, int mode) UNU;
extern void analogWrite (int pin, int value) UNU;
extern void pwmToneWrite (int pin, int freq) UNU;
extern void pwmSetMode (int mode) UNU;
extern void pwmSetRange (unsigned int range) UNU;
extern void pwmSetClock (int divisor) UNU;
extern void gpioClockSet (int pin, int freq) UNU;
extern unsigned int digitalReadByte (void) UNU;
extern unsigned int digitalReadByte2 (void) UNU;
extern void digitalWriteByte (int value) UNU;
extern void digitalWriteByte2 (int value) UNU;
// Interrupt
extern int waitForInterrupt (int pin, int mS);
extern int wiringPiISR (int pin, int mode, void (*function)(void));
// Threads
extern int piThreadCreate (void *(*fn)(void *));
extern void piLock (int key);
extern void piUnlock (int key);
// Schedulling priority
extern int piHiPri (const int pri);
// From Arduino land
extern void delay (unsigned int howLong);
extern void delayMicroseconds (unsigned int howLong);
extern unsigned int millis (void);
extern unsigned int micros (void);
#ifdef __cplusplus
}
#endif
/*----------------------------------------------------------------------------*/
#endif /* __WIRING_H__ */
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/