xref: /freebsd/sys/dev/spibus/spi.h (revision 06c3fb2749bda94cb5201f81ffdb8fa6c3161b2e)
1 /*-
2  * Copyright (c) 2006 M. Warner Losh <imp@FreeBSD.org>
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23  * SUCH DAMAGE.
24  */
25 
26 struct spi_command {
27 	void	*tx_cmd;
28 	uint32_t tx_cmd_sz;
29 	void	*rx_cmd;
30 	uint32_t rx_cmd_sz;
31 	void	*tx_data;
32 	uint32_t tx_data_sz;
33 	void	*rx_data;
34 	uint32_t rx_data_sz;
35 	uint32_t flags;
36 };
37 #define	SPI_COMMAND_INITIALIZER	{ 0 }
38 
39 #define	SPI_FLAG_KEEP_CS	0x1		/* Keep chip select asserted */
40 #define	SPI_FLAG_NO_SLEEP	0x2		/* Prevent driver from sleeping (use polling) */
41 
42 #define	SPI_CHIP_SELECT_HIGH	0x1		/* Chip select high (else low) */
43 
44 #ifdef FDT
45 #define	SPIBUS_FDT_PNP_INFO(t)	FDTCOMPAT_PNP_INFO(t, spibus)
46 #else
47 #define	SPIBUS_FDT_PNP_INFO(t)
48 #endif
49 
50 #ifdef DEV_ACPI
51 #define	SPIBUS_ACPI_PNP_INFO(t)	ACPICOMPAT_PNP_INFO(t, spibus)
52 #else
53 #define	SPIBUS_ACPI_PNP_INFO(t)
54 #endif
55