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         u_int owncount;         /* iicbus ownership nesting count */
  45         u_char started;         /* address of the 'started' slave
  46                                  * 0 if no start condition succeeded */
  47         u_char strict;          /* deny operations that violate the
  48                                  * I2C protocol */
  49         struct mtx lock;
  50         u_int bus_freq;         /* Configured bus Hz. */
  51 };
  52
  53 struct iicbus_ivar
  54 {
  55         uint32_t        addr;
  56         struct resource_list    rl;
  57         bool            nostop;
  58 };
  59
  60 enum {
  61         IICBUS_IVAR_ADDR,               /* Address or base address */
  62         IICBUS_IVAR_NOSTOP,             /* nostop defaults */
  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 IICBUS_ACCESSOR(nostop,         NOSTOP,         bool)
  70
  71 #define IICBUS_LOCK(sc)                 mtx_lock(&(sc)->lock)
  72 #define IICBUS_UNLOCK(sc)               mtx_unlock(&(sc)->lock)
  73 #define IICBUS_ASSERT_LOCKED(sc)        mtx_assert(&(sc)->lock, MA_OWNED)
  74
  75 #ifdef FDT
  76 #define IICBUS_FDT_PNPINFO(t)   FDTCOMPAT_PNP_INFO(t, iicbus)
  77 #else
  78 #define IICBUS_FDT_PNPINFO(t)
  79 #endif
  80
  81 int  iicbus_generic_intr(device_t dev, int event, char *buf);
  82 void iicbus_init_frequency(device_t dev, u_int bus_freq);
  83
  84 extern driver_t iicbus_driver;
  85 extern devclass_t iicbus_devclass;
  86 extern driver_t ofw_iicbus_driver;
  87 extern devclass_t ofw_iicbus_devclass;
  88
  89 #endif