xref: /freebsd/sys/dev/spibus/spibusvar.h (revision f39bffc62c1395bde25d152c7f68fdf7cbaab414)
1 /*-
2  * Copyright (c) 2006 M. Warner Losh
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 
29 #define SPIBUS_IVAR(d) (struct spibus_ivar *) device_get_ivars(d)
30 #define SPIBUS_SOFTC(d) (struct spibus_softc *) device_get_softc(d)
31 
32 struct spibus_softc
33 {
34 	device_t	dev;
35 };
36 
37 #define	SPIBUS_MODE_NONE	0
38 #define	SPIBUS_MODE_CPHA	1
39 #define	SPIBUS_MODE_CPOL	2
40 #define	SPIBUS_MODE_CPOL_CPHA	3
41 
42 struct spibus_ivar
43 {
44 	uint32_t	cs;
45 	uint32_t	mode;
46 	uint32_t	clock;
47 };
48 
49 #define	SPIBUS_CS_HIGH	(1U << 31)
50 
51 enum {
52 	SPIBUS_IVAR_CS,		/* chip select that we're on */
53 	SPIBUS_IVAR_MODE,	/* SPI mode (0-3) */
54 	SPIBUS_IVAR_CLOCK,	/* maximum clock freq for device */
55 };
56 
57 #define SPIBUS_ACCESSOR(A, B, T)					\
58 static inline int							\
59 spibus_get_ ## A(device_t dev, T *t)					\
60 {									\
61 	return BUS_READ_IVAR(device_get_parent(dev), dev,		\
62 	    SPIBUS_IVAR_ ## B, (uintptr_t *) t);			\
63 }									\
64 static inline int							\
65 spibus_set_ ## A(device_t dev, T t)					\
66 {									\
67 	return BUS_WRITE_IVAR(device_get_parent(dev), dev,		\
68 	    SPIBUS_IVAR_ ## B, (uintptr_t) t);			\
69 }
70 
71 SPIBUS_ACCESSOR(cs,		CS,		uint32_t)
72 SPIBUS_ACCESSOR(mode,		MODE,		uint32_t)
73 SPIBUS_ACCESSOR(clock,		CLOCK,		uint32_t)
74 
75 extern driver_t spibus_driver;
76 extern devclass_t spibus_devclass;
77 extern driver_t ofw_spibus_driver;
78 extern devclass_t ofw_spibus_devclass;
79