sys/dev/bhnd/bhndvar.h

   1 /*-
   2  * Copyright (c) 2015 Landon Fuller <landon@landonf.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer,
  10  *    without modification.
  11  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  12  *    similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
  13  *    redistribution must be conditioned upon including a substantially
  14  *    similar Disclaimer requirement for further binary redistribution.
  15  *
  16  * NO WARRANTY
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19  * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
  20  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
  21  * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
  22  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  25  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  27  * THE POSSIBILITY OF SUCH DAMAGES.
  28  *
  29  * $FreeBSD$
  30  */
  31
  32 #ifndef _BHND_BHNDVAR_H_
  33 #define _BHND_BHNDVAR_H_
  34
  35 #include <sys/param.h>
  36 #include <sys/bus.h>
  37 #include <sys/malloc.h>
  38
  39 #include "bhnd.h"
  40
  41 /*
  42  * Definitions shared by bhnd(4) bus and bhndb(4) bridge driver implementations.
  43  */
  44
  45 MALLOC_DECLARE(M_BHND);
  46 DECLARE_CLASS(bhnd_driver);
  47
  48 /**
  49  * bhnd per-device info.  Must be first member of all subclass
  50  * devinfo structures.
  51  */
  52 struct bhnd_devinfo {
  53 };
  54
  55 /**
  56  * bhnd driver instance state. Must be first member of all subclass
  57  * softc structures.
  58  */
  59 struct bhnd_softc {
  60         device_t        dev;            /**< bus device */
  61
  62         bool            attach_done;    /**< true if initialization of all
  63                                           *  platform devices has been
  64                                           *  completed */
  65         device_t        chipc_dev;      /**< bhnd_chipc device */
  66         device_t        nvram_dev;      /**< bhnd_nvram device, if any */
  67         device_t        pmu_dev;        /**< bhnd_pmu device, if any */
  68 };
  69
  70 int                      bhnd_generic_attach(device_t dev);
  71 int                      bhnd_generic_detach(device_t dev);
  72 int                      bhnd_generic_shutdown(device_t dev);
  73 int                      bhnd_generic_resume(device_t dev);
  74 int                      bhnd_generic_suspend(device_t dev);
  75
  76 int                      bhnd_generic_get_probe_order(device_t dev,
  77                              device_t child);
  78
  79 int                      bhnd_generic_print_child(device_t dev,
  80                              device_t child);
  81 void                     bhnd_generic_probe_nomatch(device_t dev,
  82                              device_t child);
  83
  84 device_t                 bhnd_generic_add_child(device_t dev, u_int order,
  85                              const char *name, int unit);
  86 void                     bhnd_generic_child_deleted(device_t dev,
  87                              device_t child);
  88 int                      bhnd_generic_suspend_child(device_t dev,
  89                              device_t child);
  90 int                      bhnd_generic_resume_child(device_t dev,
  91                              device_t child);
  92
  93 int                      bhnd_generic_get_nvram_var(device_t dev,
  94                              device_t child, const char *name, void *buf,
  95                              size_t *size, bhnd_nvram_type type);
  96
  97 #endif /* _BHND_BHNDVAR_H_ */