sys/dev/spibus/spibusvar.h

   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
  26 #define SPIBUS_IVAR(d) (struct spibus_ivar *) device_get_ivars(d)
  27 #define SPIBUS_SOFTC(d) (struct spibus_softc *) device_get_softc(d)
  28
  29 struct spibus_softc
  30 {
  31         device_t        dev;
  32 };
  33
  34 #define SPIBUS_MODE_NONE        0
  35 #define SPIBUS_MODE_CPHA        1
  36 #define SPIBUS_MODE_CPOL        2
  37 #define SPIBUS_MODE_CPOL_CPHA   3
  38
  39 struct spibus_ivar
  40 {
  41         uint32_t        cs;
  42         uint32_t        mode;
  43         uint32_t        clock;
  44         uint32_t        cs_delay;
  45         struct resource_list    rl;
  46 };
  47
  48 #define SPIBUS_CS_HIGH  (1U << 31)
  49
  50 enum {
  51         SPIBUS_IVAR_CS,         /* chip select that we're on */
  52         SPIBUS_IVAR_MODE,       /* SPI mode (0-3) */
  53         SPIBUS_IVAR_CLOCK,      /* maximum clock freq for device */
  54         SPIBUS_IVAR_CS_DELAY,   /* delay in microseconds after toggling chip select */
  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 SPIBUS_ACCESSOR(cs_delay,       CS_DELAY,       uint32_t)
  75
  76 extern driver_t spibus_driver;
  77 extern driver_t ofw_spibus_driver;
  78
  79 int spibus_attach(device_t);
  80 int spibus_detach(device_t);
  81 device_t spibus_add_child_common(device_t, u_int, const char *, int, size_t);
  82 void spibus_probe_nomatch(device_t, device_t);
  83 int spibus_child_location(device_t, device_t, struct sbuf *);
  84 int spibus_read_ivar(device_t, device_t, int, uintptr_t *);
  85 int spibus_write_ivar(device_t, device_t, int, uintptr_t);