1/*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 1998 Nicolas Souchu
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 *
28 */
29#ifndef __IICBUS_H
30#define __IICBUS_H
31
32#include <sys/_lock.h>
33#include <sys/_mutex.h>
34
35#define IICBUS_IVAR(d) (struct iicbus_ivar *) device_get_ivars(d)
36#define IICBUS_SOFTC(d) (struct iicbus_softc *) device_get_softc(d)
37
38struct iicbus_softc
39{
40 device_t dev; /* Myself */
41 device_t owner; /* iicbus owner device structure */
42 device_t busydev; /* iicbus_release_bus calls unbusy on this */
43 u_int owncount; /* iicbus ownership nesting count */
44 u_char started; /* address of the 'started' slave
45 * 0 if no start condition succeeded */
46 u_char strict; /* deny operations that violate the
47 * I2C protocol */
48 struct mtx lock;
49 u_int bus_freq; /* Configured bus Hz. */
50};
51
52struct iicbus_ivar
53{
54 uint32_t addr;
55 struct resource_list rl;
56};
57
58/* Value of 0x100 is reserved for ACPI_IVAR_HANDLE used by acpi_iicbus */
59enum {
60 IICBUS_IVAR_ADDR /* Address or base address */
61};
62
63#define IICBUS_ACCESSOR(A, B, T) \
64 __BUS_ACCESSOR(iicbus, A, IICBUS, B, T)
65
66IICBUS_ACCESSOR(addr, ADDR, uint32_t)
67
68#define IICBUS_LOCK(sc) mtx_lock(&(sc)->lock)
69#define IICBUS_UNLOCK(sc) mtx_unlock(&(sc)->lock)
70#define IICBUS_ASSERT_LOCKED(sc) mtx_assert(&(sc)->lock, MA_OWNED)
71
72#ifdef FDT
73#define IICBUS_FDT_PNP_INFO(t) FDTCOMPAT_PNP_INFO(t, iicbus)
74#else
75#define IICBUS_FDT_PNP_INFO(t)
76#endif
77
78#ifdef DEV_ACPI
79#define IICBUS_ACPI_PNP_INFO(t) ACPICOMPAT_PNP_INFO(t, iicbus)
80#else
81#define IICBUS_ACPI_PNP_INFO(t)
82#endif
83
84int iicbus_generic_intr(device_t dev, int event, char *buf);
85void iicbus_init_frequency(device_t dev, u_int bus_freq);
86
87int iicbus_attach_common(device_t dev, u_int bus_freq);
88device_t iicbus_add_child_common(device_t dev, u_int order, const char *name,
89 int unit, size_t ivars_size);
90int iicbus_detach(device_t dev);
91void iicbus_probe_nomatch(device_t bus, device_t child);
92int iicbus_read_ivar(device_t bus, device_t child, int which,
93 uintptr_t *result);
94int iicbus_write_ivar(device_t bus, device_t child, int which,
95 uintptr_t value);
96int iicbus_child_location(device_t bus, device_t child, struct sbuf *sb);
97int iicbus_child_pnpinfo(device_t bus, device_t child, struct sbuf *sb);
98
99extern driver_t iicbus_driver;
100extern driver_t ofw_iicbus_driver;
101extern driver_t acpi_iicbus_driver;
102
103#endif