text: /*-
   * Copyright (c) 1997,1998 Doug Rabson
   * All rights reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in the
   *    documentation and/or other materials provided with the distribution.
   *
   * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
   * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   *
   * $FreeBSD: src/sys/sys/bus_private.h,v 1.11 1999/09/07 08:42:49 dfr Exp $
   */
  
  #ifndef _SYS_BUS_PRIVATE_H_
  #define _SYS_BUS_PRIVATE_H_
  
  #include <sys/bus.h>
  
  /*
   * Used to attach drivers to devclasses.
   */
  typedef struct driverlink *driverlink_t;
  struct driverlink {
      driver_t		*driver;
      TAILQ_ENTRY(driverlink) link; /* list of drivers in devclass */
  };
  
  /*
   * Forward declarations
   */
  typedef TAILQ_HEAD(devclass_list, devclass) devclass_list_t;
  typedef TAILQ_HEAD(driver_list, driverlink) driver_list_t;
  typedef TAILQ_HEAD(device_list, device) device_list_t;
  
  struct devclass {
      TAILQ_ENTRY(devclass) link;
      driver_list_t	drivers; /* bus devclasses store drivers for bus */
      char		*name;
      device_t		*devices; /* array of devices indexed by unit */
      int			maxunit; /* size of devices array */
      int			nextunit; /* next unused unit number */
  };
  
  /*
   * Resources from config(8).
   */
  typedef enum {
      RES_INT, RES_STRING, RES_LONG
  } resource_type;
  
  struct config_resource {
      char		*name;
      resource_type	type;
      union {
  	long		longval;
  	int		intval;
  	char*		stringval;
      } u;
  };
  
  struct config_device {
      char		*name;	/* e.g. "lpt", "wdc" etc */
      int			unit;
      int			resource_count;
      struct config_resource	*resources;
  };
  
  /*
   * Compiled device methods.
   */
  struct device_ops {
      int maxoffset;
      devop_t methods[1];
  };
  
  /*
   * Helpers for device method wrappers.
   */
  #define DEVOPDESC(OP)	(&OP##_##desc)
  
  #define DEVOPS(DEV)	   (DEV->ops)
  #define DEVOPMETH(DEV, OP)					\
  	((DEVOPDESC(OP)->offset >= DEVOPS(DEV)->maxoffset)	\
  	 ? DEVOPDESC(OP)->deflt					\
  	 : DEVOPS(DEV)->methods[DEVOPDESC(OP)->offset])
  
  #define DRVOPS(DRV)	   ((struct device_ops *)DRV->ops)
  #define DRVOPMETH(DRV, OP)					\
  	((DEVOPDESC(OP)->offset >= DRVOPS(DRV)->maxoffset)	\
  	 ? DEVOPDESC(OP)->deflt					\
  	 : DRVOPS(DRV)->methods[DEVOPDESC(OP)->offset])
  
  /*
   * Implementation of device.
   */
  struct device {
      /*
       * Device hierarchy.
       */
      TAILQ_ENTRY(device)	link;	/* list of devices in parent */
      device_t		parent;
      device_list_t	children; /* list of subordinate devices */
  
      /*
       * Details of this device.
       */
      device_ops_t	ops;
      driver_t		*driver;
      devclass_t		devclass; /* device class which we are in */
      int			unit;
      char*		nameunit; /* name+unit e.g. foodev0 */
      char*		desc;	/* driver specific description */
      int			busy;	/* count of calls to device_busy() */
      device_state_t	state;
      u_int32_t		devflags; /* api level flags for device_get_flags() */
      u_short		flags;
  #define DF_ENABLED	1	/* device should be probed/attached */
  #define DF_FIXEDCLASS	2	/* devclass specified at create time */
  #define DF_WILDCARD	4	/* unit was originally wildcard */
  #define DF_DESCMALLOCED	8	/* description was malloced */
  #define DF_QUIET	16	/* don't print verbose attach message */
      u_char		order;	/* order from device_add_child_ordered() */
      u_char		pad;
  #ifdef DEVICE_SYSCTLS
      struct sysctl_oid	oid[4];
      struct sysctl_oid_list oidlist[1];
  #endif
      void		*ivars;
      void		*softc;
  };
  
  struct device_op_desc {
      unsigned int	offset;	/* offset in driver ops */
      struct method*	method;	/* internal method implementation */
      devop_t		deflt;	/* default implementation */
      const char*		name;	/* unique name (for registration) */
  };
  
  #endif /* !_SYS_BUS_PRIVATE_H_ */
  