125981136fb13bcacf5f475f3e0ec750341e1e671Christopher Ferris/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ 2ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris/* 3ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris * <linux/gpio.h> - userspace ABI for the GPIO character devices 4ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris * 56e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * Copyright (C) 2016 Linus Walleij 6ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris * 7ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris * This program is free software; you can redistribute it and/or modify it 8ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris * under the terms of the GNU General Public License version 2 as published by 9ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris * the Free Software Foundation. 10ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris */ 11ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris#ifndef _UAPI_GPIO_H_ 12ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris#define _UAPI_GPIO_H_ 13ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris 14ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris#include <linux/ioctl.h> 15ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris#include <linux/types.h> 16ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris 17ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris/** 18ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris * struct gpiochip_info - Information about a certain GPIO chip 19ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris * @name: the Linux kernel name of this GPIO chip 20ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris * @label: a functional name for this GPIO chip, such as a product 21ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris * number, may be NULL 22ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris * @lines: number of GPIO lines on this chip 23ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris */ 24ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferrisstruct gpiochip_info { 25ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris char name[32]; 26ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris char label[32]; 27ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris __u32 lines; 28ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris}; 29ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris 306e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris/* Informational flags */ 316e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris#define GPIOLINE_FLAG_KERNEL (1UL << 0) /* Line used by the kernel */ 32ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris#define GPIOLINE_FLAG_IS_OUT (1UL << 1) 33ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris#define GPIOLINE_FLAG_ACTIVE_LOW (1UL << 2) 34ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris#define GPIOLINE_FLAG_OPEN_DRAIN (1UL << 3) 35ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris#define GPIOLINE_FLAG_OPEN_SOURCE (1UL << 4) 36ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris 37ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris/** 38ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris * struct gpioline_info - Information about a certain GPIO line 39ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris * @line_offset: the local offset on this GPIO device, fill this in when 40ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris * requesting the line information from the kernel 41ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris * @flags: various flags for this line 42ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris * @name: the name of this GPIO line, such as the output pin of the line on the 43ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris * chip, a rail or a pin header name on a board, as specified by the gpio 44ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris * chip, may be NULL 45ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris * @consumer: a functional name for the consumer of this GPIO line as set by 46ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris * whatever is using it, will be NULL if there is no current user but may 47ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris * also be NULL if the consumer doesn't set this up 48ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris */ 49ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferrisstruct gpioline_info { 50ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris __u32 line_offset; 51ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris __u32 flags; 52ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris char name[32]; 53ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris char consumer[32]; 54ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris}; 55ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris 566e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris/* Maximum number of requested handles */ 576e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris#define GPIOHANDLES_MAX 64 586e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris 596e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris/* Linerequest flags */ 606e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris#define GPIOHANDLE_REQUEST_INPUT (1UL << 0) 616e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris#define GPIOHANDLE_REQUEST_OUTPUT (1UL << 1) 626e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris#define GPIOHANDLE_REQUEST_ACTIVE_LOW (1UL << 2) 636e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris#define GPIOHANDLE_REQUEST_OPEN_DRAIN (1UL << 3) 646e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris#define GPIOHANDLE_REQUEST_OPEN_SOURCE (1UL << 4) 656e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris 666e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris/** 676e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * struct gpiohandle_request - Information about a GPIO handle request 686e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * @lineoffsets: an array desired lines, specified by offset index for the 696e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * associated GPIO device 706e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * @flags: desired flags for the desired GPIO lines, such as 716e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * GPIOHANDLE_REQUEST_OUTPUT, GPIOHANDLE_REQUEST_ACTIVE_LOW etc, OR:ed 726e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * together. Note that even if multiple lines are requested, the same flags 736e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * must be applicable to all of them, if you want lines with individual 746e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * flags set, request them one by one. It is possible to select 756e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * a batch of input or output lines, but they must all have the same 766e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * characteristics, i.e. all inputs or all outputs, all active low etc 776e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * @default_values: if the GPIOHANDLE_REQUEST_OUTPUT is set for a requested 786e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * line, this specifies the default output value, should be 0 (low) or 796e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * 1 (high), anything else than 0 or 1 will be interpreted as 1 (high) 806e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * @consumer_label: a desired consumer label for the selected GPIO line(s) 816e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * such as "my-bitbanged-relay" 826e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * @lines: number of lines requested in this request, i.e. the number of 836e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * valid fields in the above arrays, set to 1 to request a single line 846e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * @fd: if successful this field will contain a valid anonymous file handle 856e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * after a GPIO_GET_LINEHANDLE_IOCTL operation, zero or negative value 866e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * means error 876e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris */ 886e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferrisstruct gpiohandle_request { 896e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris __u32 lineoffsets[GPIOHANDLES_MAX]; 906e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris __u32 flags; 916e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris __u8 default_values[GPIOHANDLES_MAX]; 926e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris char consumer_label[32]; 936e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris __u32 lines; 946e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris int fd; 956e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris}; 966e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris 976e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris/** 986e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * struct gpiohandle_data - Information of values on a GPIO handle 996e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * @values: when getting the state of lines this contains the current 1006e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * state of a line, when setting the state of lines these should contain 1016e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * the desired target state 1026e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris */ 1036e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferrisstruct gpiohandle_data { 1046e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris __u8 values[GPIOHANDLES_MAX]; 1056e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris}; 1066e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris 1076e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris#define GPIOHANDLE_GET_LINE_VALUES_IOCTL _IOWR(0xB4, 0x08, struct gpiohandle_data) 1086e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris#define GPIOHANDLE_SET_LINE_VALUES_IOCTL _IOWR(0xB4, 0x09, struct gpiohandle_data) 1096e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris 1106e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris/* Eventrequest flags */ 1116e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris#define GPIOEVENT_REQUEST_RISING_EDGE (1UL << 0) 1126e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris#define GPIOEVENT_REQUEST_FALLING_EDGE (1UL << 1) 1136e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris#define GPIOEVENT_REQUEST_BOTH_EDGES ((1UL << 0) | (1UL << 1)) 1146e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris 1156e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris/** 1166e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * struct gpioevent_request - Information about a GPIO event request 1176e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * @lineoffset: the desired line to subscribe to events from, specified by 1186e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * offset index for the associated GPIO device 1196e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * @handleflags: desired handle flags for the desired GPIO line, such as 1206e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * GPIOHANDLE_REQUEST_ACTIVE_LOW or GPIOHANDLE_REQUEST_OPEN_DRAIN 1216e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * @eventflags: desired flags for the desired GPIO event line, such as 1226e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * GPIOEVENT_REQUEST_RISING_EDGE or GPIOEVENT_REQUEST_FALLING_EDGE 1236e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * @consumer_label: a desired consumer label for the selected GPIO line(s) 1246e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * such as "my-listener" 1256e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * @fd: if successful this field will contain a valid anonymous file handle 1266e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * after a GPIO_GET_LINEEVENT_IOCTL operation, zero or negative value 1276e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * means error 1286e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris */ 1296e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferrisstruct gpioevent_request { 1306e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris __u32 lineoffset; 1316e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris __u32 handleflags; 1326e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris __u32 eventflags; 1336e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris char consumer_label[32]; 1346e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris int fd; 1356e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris}; 1366e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris 1376e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris/** 1386e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * GPIO event types 1396e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris */ 1406e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris#define GPIOEVENT_EVENT_RISING_EDGE 0x01 1416e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris#define GPIOEVENT_EVENT_FALLING_EDGE 0x02 1426e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris 1436e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris/** 1446e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * struct gpioevent_data - The actual event being pushed to userspace 1456e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * @timestamp: best estimate of time of event occurrence, in nanoseconds 1466e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris * @id: event identifier 1476e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris */ 1486e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferrisstruct gpioevent_data { 1496e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris __u64 timestamp; 1506e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris __u32 id; 1516e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris}; 1526e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris 153ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris#define GPIO_GET_CHIPINFO_IOCTL _IOR(0xB4, 0x01, struct gpiochip_info) 154ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris#define GPIO_GET_LINEINFO_IOCTL _IOWR(0xB4, 0x02, struct gpioline_info) 1556e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris#define GPIO_GET_LINEHANDLE_IOCTL _IOWR(0xB4, 0x03, struct gpiohandle_request) 1566e3550f2a1c3909fb75be068f7ae9009f7e8622aChristopher Ferris#define GPIO_GET_LINEEVENT_IOCTL _IOWR(0xB4, 0x04, struct gpioevent_request) 157ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris 158ccfaccd726a369b7df72e251710755233d176e5aChristopher Ferris#endif /* _UAPI_GPIO_H_ */ 159