xref: /freebsd/sys/dev/spibus/spibusvar.h (revision 37c8ee8847faa53432809cae2ecc11b80c4eab2f)
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 	uint32_t	cs_delay;
47 	struct resource_list	rl;
48 };
49 
50 #define	SPIBUS_CS_HIGH	(1U << 31)
51 
52 enum {
53 	SPIBUS_IVAR_CS,		/* chip select that we're on */
54 	SPIBUS_IVAR_MODE,	/* SPI mode (0-3) */
55 	SPIBUS_IVAR_CLOCK,	/* maximum clock freq for device */
56 	SPIBUS_IVAR_CS_DELAY,	/* delay in microseconds after toggling chip select */
57 };
58 
59 #define SPIBUS_ACCESSOR(A, B, T)					\
60 static inline int							\
61 spibus_get_ ## A(device_t dev, T *t)					\
62 {									\
63 	return BUS_READ_IVAR(device_get_parent(dev), dev,		\
64 	    SPIBUS_IVAR_ ## B, (uintptr_t *) t);			\
65 }									\
66 static inline int							\
67 spibus_set_ ## A(device_t dev, T t)					\
68 {									\
69 	return BUS_WRITE_IVAR(device_get_parent(dev), dev,		\
70 	    SPIBUS_IVAR_ ## B, (uintptr_t) t);			\
71 }
72 
73 SPIBUS_ACCESSOR(cs,		CS,		uint32_t)
74 SPIBUS_ACCESSOR(mode,		MODE,		uint32_t)
75 SPIBUS_ACCESSOR(clock,		CLOCK,		uint32_t)
76 SPIBUS_ACCESSOR(cs_delay,	CS_DELAY,	uint32_t)
77 
78 extern driver_t spibus_driver;
79 extern driver_t ofw_spibus_driver;
80 
81 int spibus_attach(device_t);
82 int spibus_detach(device_t);
83 device_t spibus_add_child_common(device_t, u_int, const char *, int, size_t);
84 void spibus_probe_nomatch(device_t, device_t);
85 int spibus_child_location(device_t, device_t, struct sbuf *);
86 int spibus_read_ivar(device_t, device_t, int, uintptr_t *);
87 int spibus_write_ivar(device_t, device_t, int, uintptr_t);
88