[mirror_ubuntu-focal-kernel.git] / include / uapi / linux / spi / spidev.h

/* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */
/*
 * include/linux/spi/spidev.h
 *
 * Copyright (C) 2006 SWAPP
 *	Andrea Paterniani <a.paterniani@swapp-eng.it>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  */

#ifndef SPIDEV_H
#define SPIDEV_H

#include <linux/types.h>
#include <linux/ioctl.h>

/* User space versions of kernel symbols for SPI clocking modes,
 * matching <linux/spi/spi.h>
 */

#define SPI_CPHA		0x01
#define SPI_CPOL		0x02

#define SPI_MODE_0		(0|0)
#define SPI_MODE_1		(0|SPI_CPHA)
#define SPI_MODE_2		(SPI_CPOL|0)
#define SPI_MODE_3		(SPI_CPOL|SPI_CPHA)

#define SPI_CS_HIGH		0x04
#define SPI_LSB_FIRST		0x08
#define SPI_3WIRE		0x10
#define SPI_LOOP		0x20
#define SPI_NO_CS		0x40
#define SPI_READY		0x80
#define SPI_TX_DUAL		0x100
#define SPI_TX_QUAD		0x200
#define SPI_RX_DUAL		0x400
#define SPI_RX_QUAD		0x800

/*---------------------------------------------------------------------------*/

/* IOCTL commands */

#define SPI_IOC_MAGIC			'k'

/**
 * struct spi_ioc_transfer - describes a single SPI transfer
 * @tx_buf: Holds pointer to userspace buffer with transmit data, or null.
 *	If no data is provided, zeroes are shifted out.
 * @rx_buf: Holds pointer to userspace buffer for receive data, or null.
 * @len: Length of tx and rx buffers, in bytes.
 * @speed_hz: Temporary override of the device's bitrate.
 * @bits_per_word: Temporary override of the device's wordsize.
 * @delay_usecs: If nonzero, how long to delay after the last bit transfer
 *	before optionally deselecting the device before the next transfer.
 * @cs_change: True to deselect device before starting the next transfer.
 *
 * This structure is mapped directly to the kernel spi_transfer structure;
 * the fields have the same meanings, except of course that the pointers
 * are in a different address space (and may be of different sizes in some
 * cases, such as 32-bit i386 userspace over a 64-bit x86_64 kernel).
 * Zero-initialize the structure, including currently unused fields, to
 * accommodate potential future updates.
 *
 * SPI_IOC_MESSAGE gives userspace the equivalent of kernel spi_sync().
 * Pass it an array of related transfers, they'll execute together.
 * Each transfer may be half duplex (either direction) or full duplex.
 *
 *	struct spi_ioc_transfer mesg[4];
 *	...
 *	status = ioctl(fd, SPI_IOC_MESSAGE(4), mesg);
 *
 * So for example one transfer might send a nine bit command (right aligned
 * in a 16-bit word), the next could read a block of 8-bit data before
 * terminating that command by temporarily deselecting the chip; the next
 * could send a different nine bit command (re-selecting the chip), and the
 * last transfer might write some register values.
 */
struct spi_ioc_transfer {
	__u64		tx_buf;
	__u64		rx_buf;

	__u32		len;
	__u32		speed_hz;

	__u16		delay_usecs;
	__u8		bits_per_word;
	__u8		cs_change;
	__u8		tx_nbits;
	__u8		rx_nbits;
	__u16		pad;

	/* If the contents of 'struct spi_ioc_transfer' ever change
	 * incompatibly, then the ioctl number (currently 0) must change;
	 * ioctls with constant size fields get a bit more in the way of
	 * error checking than ones (like this) where that field varies.
	 *
	 * NOTE: struct layout is the same in 64bit and 32bit userspace.
	 */
};

/* not all platforms use <asm-generic/ioctl.h> or _IOC_TYPECHECK() ... */
#define SPI_MSGSIZE(N) \
	((((N)*(sizeof (struct spi_ioc_transfer))) < (1 << _IOC_SIZEBITS)) \
		? ((N)*(sizeof (struct spi_ioc_transfer))) : 0)
#define SPI_IOC_MESSAGE(N) _IOW(SPI_IOC_MAGIC, 0, char[SPI_MSGSIZE(N)])


/* Read / Write of SPI mode (SPI_MODE_0..SPI_MODE_3) (limited to 8 bits) */
#define SPI_IOC_RD_MODE			_IOR(SPI_IOC_MAGIC, 1, __u8)
#define SPI_IOC_WR_MODE			_IOW(SPI_IOC_MAGIC, 1, __u8)

/* Read / Write SPI bit justification */
#define SPI_IOC_RD_LSB_FIRST		_IOR(SPI_IOC_MAGIC, 2, __u8)
#define SPI_IOC_WR_LSB_FIRST		_IOW(SPI_IOC_MAGIC, 2, __u8)

/* Read / Write SPI device word length (1..N) */
#define SPI_IOC_RD_BITS_PER_WORD	_IOR(SPI_IOC_MAGIC, 3, __u8)
#define SPI_IOC_WR_BITS_PER_WORD	_IOW(SPI_IOC_MAGIC, 3, __u8)

/* Read / Write SPI device default max speed hz */
#define SPI_IOC_RD_MAX_SPEED_HZ		_IOR(SPI_IOC_MAGIC, 4, __u32)
#define SPI_IOC_WR_MAX_SPEED_HZ		_IOW(SPI_IOC_MAGIC, 4, __u32)

/* Read / Write of the SPI mode field */
#define SPI_IOC_RD_MODE32		_IOR(SPI_IOC_MAGIC, 5, __u32)
#define SPI_IOC_WR_MODE32		_IOW(SPI_IOC_MAGIC, 5, __u32)


#endif /* SPIDEV_H */
Commit	Line	Data
e2be04c7	1	/* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */
814a8d50 AP	2	/*
	3	* include/linux/spi/spidev.h
	4	*
	5	* Copyright (C) 2006 SWAPP
	6	* Andrea Paterniani <a.paterniani@swapp-eng.it>
	7	*
	8	* This program is free software; you can redistribute it and/or modify
	9	* it under the terms of the GNU General Public License as published by
	10	* the Free Software Foundation; either version 2 of the License, or
	11	* (at your option) any later version.
	12	*
	13	* This program is distributed in the hope that it will be useful,
	14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	* GNU General Public License for more details.
	17	*
	18	* You should have received a copy of the GNU General Public License
	19	* along with this program; if not, write to the Free Software
	20	* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
	21	*/
	22
	23	#ifndef SPIDEV_H
	24	#define SPIDEV_H
	25
550e978a	26	#include <linux/types.h>
a2b4a79b	27	#include <linux/ioctl.h>
814a8d50 AP	28
	29	/* User space versions of kernel symbols for SPI clocking modes,
	30	* matching <linux/spi/spi.h>
	31	*/
	32
	33	#define SPI_CPHA 0x01
	34	#define SPI_CPOL 0x02
	35
	36	#define SPI_MODE_0 (0\|0)
	37	#define SPI_MODE_1 (0\|SPI_CPHA)
	38	#define SPI_MODE_2 (SPI_CPOL\|0)
	39	#define SPI_MODE_3 (SPI_CPOL\|SPI_CPHA)
	40
6f166e38 AV	41	#define SPI_CS_HIGH 0x04
	42	#define SPI_LSB_FIRST 0x08
	43	#define SPI_3WIRE 0x10
	44	#define SPI_LOOP 0x20
b55f627f DB	45	#define SPI_NO_CS 0x40
b55f627f DB	46	#define SPI_READY 0x80
dc64d39b GU	47	#define SPI_TX_DUAL 0x100
	48	#define SPI_TX_QUAD 0x200
	49	#define SPI_RX_DUAL 0x400
	50	#define SPI_RX_QUAD 0x800
814a8d50 AP	51
	52	/---------------------------------------------------------------------------/
	53
	54	/* IOCTL commands */
	55
	56	#define SPI_IOC_MAGIC 'k'
	57
	58	/**
	59	* struct spi_ioc_transfer - describes a single SPI transfer
	60	* @tx_buf: Holds pointer to userspace buffer with transmit data, or null.
	61	* If no data is provided, zeroes are shifted out.
	62	* @rx_buf: Holds pointer to userspace buffer for receive data, or null.
	63	* @len: Length of tx and rx buffers, in bytes.
	64	* @speed_hz: Temporary override of the device's bitrate.
	65	* @bits_per_word: Temporary override of the device's wordsize.
	66	* @delay_usecs: If nonzero, how long to delay after the last bit transfer
	67	* before optionally deselecting the device before the next transfer.
	68	* @cs_change: True to deselect device before starting the next transfer.
	69	*
	70	* This structure is mapped directly to the kernel spi_transfer structure;
	71	* the fields have the same meanings, except of course that the pointers
	72	* are in a different address space (and may be of different sizes in some
	73	* cases, such as 32-bit i386 userspace over a 64-bit x86_64 kernel).
	74	* Zero-initialize the structure, including currently unused fields, to
25985edc	75	* accommodate potential future updates.
814a8d50 AP	76	*
	77	* SPI_IOC_MESSAGE gives userspace the equivalent of kernel spi_sync().
	78	* Pass it an array of related transfers, they'll execute together.
	79	* Each transfer may be half duplex (either direction) or full duplex.
	80	*
	81	* struct spi_ioc_transfer mesg[4];
	82	* ...
	83	* status = ioctl(fd, SPI_IOC_MESSAGE(4), mesg);
	84	*
	85	* So for example one transfer might send a nine bit command (right aligned
	86	* in a 16-bit word), the next could read a block of 8-bit data before
	87	* terminating that command by temporarily deselecting the chip; the next
	88	* could send a different nine bit command (re-selecting the chip), and the
	89	* last transfer might write some register values.
	90	*/
	91	struct spi_ioc_transfer {
	92	__u64 tx_buf;
	93	__u64 rx_buf;
	94
	95	__u32 len;
	96	__u32 speed_hz;
	97
	98	__u16 delay_usecs;
	99	__u8 bits_per_word;
	100	__u8 cs_change;
dc64d39b GU	101	__u8 tx_nbits;
	102	__u8 rx_nbits;
	103	__u16 pad;
814a8d50 AP	104
	105	/* If the contents of 'struct spi_ioc_transfer' ever change
	106	* incompatibly, then the ioctl number (currently 0) must change;
	107	* ioctls with constant size fields get a bit more in the way of
	108	* error checking than ones (like this) where that field varies.
	109	*
	110	* NOTE: struct layout is the same in 64bit and 32bit userspace.
	111	*/
	112	};
	113
	114	/* not all platforms use <asm-generic/ioctl.h> or _IOC_TYPECHECK() ... */
	115	#define SPI_MSGSIZE(N) \
	116	((((N)*(sizeof (struct spi_ioc_transfer))) < (1 << _IOC_SIZEBITS)) \
	117	? ((N)*(sizeof (struct spi_ioc_transfer))) : 0)
	118	#define SPI_IOC_MESSAGE(N) _IOW(SPI_IOC_MAGIC, 0, char[SPI_MSGSIZE(N)])
	119
	120
dc64d39b	121	/* Read / Write of SPI mode (SPI_MODE_0..SPI_MODE_3) (limited to 8 bits) */
814a8d50 AP	122	#define SPI_IOC_RD_MODE _IOR(SPI_IOC_MAGIC, 1, __u8)
	123	#define SPI_IOC_WR_MODE _IOW(SPI_IOC_MAGIC, 1, __u8)
	124
	125	/* Read / Write SPI bit justification */
	126	#define SPI_IOC_RD_LSB_FIRST _IOR(SPI_IOC_MAGIC, 2, __u8)
	127	#define SPI_IOC_WR_LSB_FIRST _IOW(SPI_IOC_MAGIC, 2, __u8)
	128
	129	/* Read / Write SPI device word length (1..N) */
	130	#define SPI_IOC_RD_BITS_PER_WORD _IOR(SPI_IOC_MAGIC, 3, __u8)
	131	#define SPI_IOC_WR_BITS_PER_WORD _IOW(SPI_IOC_MAGIC, 3, __u8)
	132
	133	/* Read / Write SPI device default max speed hz */
	134	#define SPI_IOC_RD_MAX_SPEED_HZ _IOR(SPI_IOC_MAGIC, 4, __u32)
	135	#define SPI_IOC_WR_MAX_SPEED_HZ _IOW(SPI_IOC_MAGIC, 4, __u32)
	136
dc64d39b GU	137	/* Read / Write of the SPI mode field */
	138	#define SPI_IOC_RD_MODE32 _IOR(SPI_IOC_MAGIC, 5, __u32)
	139	#define SPI_IOC_WR_MODE32 _IOW(SPI_IOC_MAGIC, 5, __u32)
	140
814a8d50 AP	141
	142
	143	#endif /* SPIDEV_H */