sys/dev/iicbus/iicbus.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   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  * $FreeBSD$
  29  *
  30  */
  31 #ifndef __IICBUS_H
  32 #define __IICBUS_H
  33
  34 #include <sys/_lock.h>
  35 #include <sys/_mutex.h>
  36
  37 #define IICBUS_IVAR(d) (struct iicbus_ivar *) device_get_ivars(d)
  38 #define IICBUS_SOFTC(d) (struct iicbus_softc *) device_get_softc(d)
  39
  40 struct iicbus_softc
  41 {
  42         device_t dev;           /* Myself */
  43         device_t owner;         /* iicbus owner device structure */
  44         device_t busydev;       /* iicbus_release_bus calls unbusy on this */
  45         u_int owncount;         /* iicbus ownership nesting count */
  46         u_char started;         /* address of the 'started' slave
  47                                  * 0 if no start condition succeeded */
  48         u_char strict;          /* deny operations that violate the
  49                                  * I2C protocol */
  50         struct mtx lock;
  51         u_int bus_freq;         /* Configured bus Hz. */
  52 };
  53
  54 struct iicbus_ivar
  55 {
  56         uint32_t        addr;
  57         struct resource_list    rl;
  58 };
  59
  60 /* Value of 0x100 is reserved for ACPI_IVAR_HANDLE used by acpi_iicbus */
  61 enum {
  62         IICBUS_IVAR_ADDR                /* Address or base address */
  63 };
  64
  65 #define IICBUS_ACCESSOR(A, B, T)                                        \
  66         __BUS_ACCESSOR(iicbus, A, IICBUS, B, T)
  67
  68 IICBUS_ACCESSOR(addr,           ADDR,           uint32_t)
  69
  70 #define IICBUS_LOCK(sc)                 mtx_lock(&(sc)->lock)
  71 #define IICBUS_UNLOCK(sc)               mtx_unlock(&(sc)->lock)
  72 #define IICBUS_ASSERT_LOCKED(sc)        mtx_assert(&(sc)->lock, MA_OWNED)
  73
  74 #ifdef FDT
  75 #define IICBUS_FDT_PNP_INFO(t)  FDTCOMPAT_PNP_INFO(t, iicbus)
  76 #else
  77 #define IICBUS_FDT_PNP_INFO(t)
  78 #endif
  79
  80 #ifdef DEV_ACPI
  81 #define IICBUS_ACPI_PNP_INFO(t) ACPICOMPAT_PNP_INFO(t, iicbus)
  82 #else
  83 #define IICBUS_ACPI_PNP_INFO(t)
  84 #endif
  85
  86 int  iicbus_generic_intr(device_t dev, int event, char *buf);
  87 void iicbus_init_frequency(device_t dev, u_int bus_freq);
  88
  89 int iicbus_attach_common(device_t dev, u_int bus_freq);
  90 device_t iicbus_add_child_common(device_t dev, u_int order, const char *name,
  91     int unit, size_t ivars_size);
  92 int iicbus_detach(device_t dev);
  93 void iicbus_probe_nomatch(device_t bus, device_t child);
  94 int iicbus_read_ivar(device_t bus, device_t child, int which,
  95     uintptr_t *result);
  96 int iicbus_write_ivar(device_t bus, device_t child, int which,
  97     uintptr_t value);
  98 int iicbus_child_location_str(device_t bus, device_t child, char *buf,
  99     size_t buflen);
 100 int iicbus_child_pnpinfo_str(device_t bus, device_t child, char *buf,
 101     size_t buflen);
 102
 103 extern driver_t iicbus_driver;
 104 extern devclass_t iicbus_devclass;
 105 extern driver_t ofw_iicbus_driver;
 106 extern devclass_t ofw_iicbus_devclass;
 107 extern driver_t acpi_iicbus_driver;
 108
 109 #endif