sys/dev/pccbb/pccbbvar.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2000,2001 Jonathan Chen All rights reserved.
   5  * Copyright (c) 2003-2004 M. Warner Losh <imp@FreeBSD.org>
   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 /*
  32  * Structure definitions for the Cardbus Bridge driver
  33  */
  34
  35 struct cbb_intrhand {
  36         driver_filter_t *filt;
  37         driver_intr_t   *intr;
  38         void            *arg;
  39         struct cbb_softc *sc;
  40         void            *cookie;
  41 };
  42
  43 struct cbb_reslist {
  44         SLIST_ENTRY(cbb_reslist) link;
  45         struct  resource *res;
  46         int     type;
  47         int     rid;
  48                 /* note: unlike the regular resource list, there can be
  49                  * duplicate rid's in the same list.  However, the
  50                  * combination of rid and res->r_dev should be unique.
  51                  */
  52         bus_addr_t cardaddr; /* for 16-bit pccard memory */
  53 };
  54
  55 #define CBB_AUTO_OPEN_SMALLHOLE 0x100
  56 #define CBB_NSLOTS              4
  57
  58 struct cbb_softc {
  59         device_t        dev;
  60         struct exca_softc exca[CBB_NSLOTS];
  61         struct          resource *base_res;
  62         struct          resource *irq_res;
  63         void            *intrhand;
  64         bus_space_tag_t bst;
  65         bus_space_handle_t bsh;
  66         uint32_t        domain;
  67         unsigned int    pribus;
  68         struct pcib_secbus bus;
  69         struct mtx      mtx;
  70         int             cardok;
  71         u_int32_t       flags;
  72 #define CBB_16BIT_CARD          0x20000000
  73 #define CBB_KTHREAD_RUNNING     0x40000000
  74 #define CBB_KTHREAD_DONE        0x80000000
  75         int             chipset;                /* chipset id */
  76 #define CB_UNKNOWN      0               /* NOT Cardbus-PCI bridge */
  77 #define CB_TI113X       1               /* TI PCI1130/1131 */
  78 #define CB_TI12XX       2               /* TI PCI12xx/14xx/44xx/15xx/45xx */
  79 #define CB_TI125X       3               /* TI PCI1250/1251(B)/1450 */
  80 #define CB_RF5C47X      4               /* RICOH RF5C475/476/477 */
  81 #define CB_RF5C46X      5               /* RICOH RF5C465/466/467 */
  82 #define CB_CIRRUS       6               /* Cirrus Logic CLPD683x */
  83 #define CB_TOPIC95      7               /* Toshiba ToPIC95 */
  84 #define CB_TOPIC97      8               /* Toshiba ToPIC97/100 */
  85 #define CB_O2MICRO      9               /* O2Micro chips */
  86         SLIST_HEAD(, cbb_reslist) rl;
  87         device_t        cbdev;
  88         struct proc     *event_thread;
  89         void (*chipinit)(struct cbb_softc *);
  90         int     powerintr;
  91         struct root_hold_token *sc_root_token;
  92 };
  93
  94 /* result of detect_card */
  95 #define CARD_UKN_CARD   0x00
  96 #define CARD_5V_CARD    0x01
  97 #define CARD_3V_CARD    0x02
  98 #define CARD_XV_CARD    0x04
  99 #define CARD_YV_CARD    0x08
 100
 101 /* for power_socket */
 102 #define CARD_VCC(X)     (X)
 103 #define CARD_VPP_VCC    0xf0
 104 #define CARD_VCCMASK    0xf
 105 #define CARD_VCCSHIFT   0
 106 #define XV              2
 107 #define YV              1
 108
 109 #define CARD_OFF        (CARD_VCC(0))
 110
 111 extern int cbb_debug;
 112 extern devclass_t cbb_devclass;
 113
 114 int     cbb_activate_resource(device_t brdev, device_t child,
 115             int type, int rid, struct resource *r);
 116 struct resource *cbb_alloc_resource(device_t brdev, device_t child,
 117             int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count,
 118             u_int flags);
 119 void    cbb_child_detached(device_t brdev, device_t child);
 120 int     cbb_child_present(device_t parent, device_t child);
 121 int     cbb_deactivate_resource(device_t brdev, device_t child,
 122             int type, int rid, struct resource *r);
 123 int     cbb_detach(device_t brdev);
 124 void    cbb_disable_func_intr(struct cbb_softc *sc);
 125 void    cbb_driver_added(device_t brdev, driver_t *driver);
 126 void    cbb_event_thread(void *arg);
 127 int     cbb_pcic_set_memory_offset(device_t brdev, device_t child, int rid,
 128             uint32_t cardaddr, uint32_t *deltap);
 129 int     cbb_pcic_set_res_flags(device_t brdev, device_t child, int type,
 130             int rid, u_long flags);
 131 int     cbb_power(device_t brdev, int volts);
 132 int     cbb_power_enable_socket(device_t brdev, device_t child);
 133 int     cbb_power_disable_socket(device_t brdev, device_t child);
 134 int     cbb_read_ivar(device_t brdev, device_t child, int which,
 135             uintptr_t *result);
 136 int     cbb_release_resource(device_t brdev, device_t child,
 137             int type, int rid, struct resource *r);
 138 int     cbb_setup_intr(device_t dev, device_t child, struct resource *irq,
 139             int flags, driver_filter_t *filt, driver_intr_t *intr, void *arg,
 140             void **cookiep);
 141 int     cbb_teardown_intr(device_t dev, device_t child, struct resource *irq,
 142             void *cookie);
 143 int     cbb_write_ivar(device_t brdev, device_t child, int which,
 144             uintptr_t value);
 145
 146 /*
 147  */
 148 static __inline void
 149 cbb_set(struct cbb_softc *sc, uint32_t reg, uint32_t val)
 150 {
 151         bus_space_write_4(sc->bst, sc->bsh, reg, val);
 152 }
 153
 154 static __inline uint32_t
 155 cbb_get(struct cbb_softc *sc, uint32_t reg)
 156 {
 157         return (bus_space_read_4(sc->bst, sc->bsh, reg));
 158 }
 159
 160 static __inline void
 161 cbb_setb(struct cbb_softc *sc, uint32_t reg, uint32_t bits)
 162 {
 163         cbb_set(sc, reg, cbb_get(sc, reg) | bits);
 164 }
 165
 166 static __inline void
 167 cbb_clrb(struct cbb_softc *sc, uint32_t reg, uint32_t bits)
 168 {
 169         cbb_set(sc, reg, cbb_get(sc, reg) & ~bits);
 170 }