sys/dev/puc/puc_bfe.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2006 Marcel Moolenaar
   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  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  *
  28  * $FreeBSD$
  29  */
  30
  31 #ifndef _DEV_PUC_BFE_H_
  32 #define _DEV_PUC_BFE_H_
  33
  34 #define PUC_PCI_BARS    6
  35
  36 struct puc_cfg;
  37 struct puc_port;
  38
  39 extern const struct puc_cfg puc_pci_devices[];
  40
  41 extern devclass_t puc_devclass;
  42 extern const char puc_driver_name[];
  43
  44 struct puc_bar {
  45         struct resource *b_res;
  46         int             b_rid;
  47         int             b_type;
  48 };
  49
  50 struct puc_softc {
  51         device_t        sc_dev;
  52
  53         const struct puc_cfg *sc_cfg;
  54         intptr_t        sc_cfg_data;
  55
  56         struct puc_bar  sc_bar[PUC_PCI_BARS];
  57         struct rman     sc_ioport;
  58         struct rman     sc_iomem;
  59         struct rman     sc_irq;
  60
  61         struct resource *sc_ires;
  62         void            *sc_icookie;
  63         int             sc_irid;
  64
  65         int             sc_nports;
  66         struct puc_port *sc_port;
  67
  68         int             sc_fastintr:1;
  69         int             sc_leaving:1;
  70         int             sc_polled:1;
  71         int             sc_msi:1;
  72
  73         int             sc_ilr;
  74
  75         /*
  76          * Bitmask of ports that use the serdev I/F. This allows for
  77          * 32 ports on ILP32 machines and 64 ports on LP64 machines.
  78          */
  79         u_long          sc_serdevs;
  80 };
  81
  82 struct puc_bar *puc_get_bar(struct puc_softc *sc, int rid);
  83
  84 int puc_bfe_attach(device_t);
  85 int puc_bfe_detach(device_t);
  86 int puc_bfe_probe(device_t, const struct puc_cfg *);
  87
  88 int puc_bus_child_location_str(device_t, device_t, char *, size_t);
  89 int puc_bus_child_pnpinfo_str(device_t, device_t, char *, size_t);
  90 struct resource *puc_bus_alloc_resource(device_t, device_t, int, int *,
  91     rman_res_t, rman_res_t, rman_res_t, u_int);
  92 int puc_bus_get_resource(device_t, device_t, int, int, rman_res_t *, rman_res_t *);
  93 int puc_bus_print_child(device_t, device_t);
  94 int puc_bus_read_ivar(device_t, device_t, int, uintptr_t *);
  95 int puc_bus_release_resource(device_t, device_t, int, int, struct resource *);
  96 int puc_bus_setup_intr(device_t, device_t, struct resource *, int,
  97     driver_filter_t *, driver_intr_t *, void *, void **);
  98 int puc_bus_teardown_intr(device_t, device_t, struct resource *, void *);
  99
 100 SYSCTL_DECL(_hw_puc);
 101
 102 #endif /* _DEV_PUC_BFE_H_ */