sys/dev/bhnd/bhndvar.h

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