xref: /freebsd/sys/dev/spibus/spibusvar.h (revision b0d29bc47dba79f6f38e67eabadfb4b32ffd9390)
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  * $FreeBSD$
26  */
27 
28 #define SPIBUS_IVAR(d) (struct spibus_ivar *) device_get_ivars(d)
29 #define SPIBUS_SOFTC(d) (struct spibus_softc *) device_get_softc(d)
30 
31 struct spibus_softc
32 {
33 	device_t	dev;
34 };
35 
36 #define	SPIBUS_MODE_NONE	0
37 #define	SPIBUS_MODE_CPHA	1
38 #define	SPIBUS_MODE_CPOL	2
39 #define	SPIBUS_MODE_CPOL_CPHA	3
40 
41 struct spibus_ivar
42 {
43 	uint32_t	cs;
44 	uint32_t	mode;
45 	uint32_t	clock;
46 };
47 
48 #define	SPIBUS_CS_HIGH	(1U << 31)
49 
50 enum {
51 	SPIBUS_IVAR_CS,		/* chip select that we're on */
52 	SPIBUS_IVAR_MODE,	/* SPI mode (0-3) */
53 	SPIBUS_IVAR_CLOCK,	/* maximum clock freq for device */
54 };
55 
56 #define SPIBUS_ACCESSOR(A, B, T)					\
57 static inline int							\
58 spibus_get_ ## A(device_t dev, T *t)					\
59 {									\
60 	return BUS_READ_IVAR(device_get_parent(dev), dev,		\
61 	    SPIBUS_IVAR_ ## B, (uintptr_t *) t);			\
62 }									\
63 static inline int							\
64 spibus_set_ ## A(device_t dev, T t)					\
65 {									\
66 	return BUS_WRITE_IVAR(device_get_parent(dev), dev,		\
67 	    SPIBUS_IVAR_ ## B, (uintptr_t) t);			\
68 }
69 
70 SPIBUS_ACCESSOR(cs,		CS,		uint32_t)
71 SPIBUS_ACCESSOR(mode,		MODE,		uint32_t)
72 SPIBUS_ACCESSOR(clock,		CLOCK,		uint32_t)
73 
74 extern driver_t spibus_driver;
75 extern devclass_t spibus_devclass;
76 extern driver_t ofw_spibus_driver;
77 extern devclass_t ofw_spibus_devclass;
78