sys/powerpc/include/platformvar.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2005 Peter Grehan
   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  * 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 #ifndef _MACHINE_PLATFORMVAR_H_
  32 #define _MACHINE_PLATFORMVAR_H_
  33
  34 /*
  35  * A PowerPC platform implementation is declared with a kernel object and
  36  * an associated method table, similar to a device driver.
  37  *
  38  * e.g.
  39  *
  40  * static platform_method_t chrp_methods[] = {
  41  *      PLATFORMMETHOD(platform_probe,          chrp_probe),
  42  *      PLATFORMMETHOD(platform_mem_regions,    ofw_mem_regions),
  43  *  ...
  44  *      PLATFORMMETHOD(platform_smp_first_cpu,  chrp_smp_first_cpu),
  45  *      { 0, 0 }
  46  * };
  47  *
  48  * static platform_def_t chrp_platform = {
  49  *      "chrp",
  50  *      chrp_methods,
  51  *      sizeof(chrp_platform_softc),    // or 0 if no softc
  52  * };
  53  *
  54  * PLATFORM_DEF(chrp_platform);
  55  */
  56
  57 #include <sys/kobj.h>
  58
  59 struct platform_kobj {
  60         /*
  61          * A platform instance is a kernel object
  62          */
  63         KOBJ_FIELDS;
  64
  65         /*
  66          * Utility elements that an instance may use
  67          */
  68         struct mtx      platform_mtx;   /* available for instance use */
  69         void            *platform_iptr; /* instance data pointer */
  70
  71         /*
  72          * Opaque data that can be overlaid with an instance-private
  73          * structure. Platform code can test that this is large enough at
  74          * compile time with a sizeof() test againt it's softc. There
  75          * is also a run-time test when the platform kernel object is
  76          * registered.
  77          */
  78 #define PLATFORM_OPAQUESZ       64
  79         u_int           platform_opaque[PLATFORM_OPAQUESZ];
  80 };
  81
  82 typedef struct platform_kobj    *platform_t;
  83 typedef struct kobj_class       platform_def_t;
  84 #define platform_method_t       kobj_method_t
  85
  86 #define PLATFORMMETHOD          KOBJMETHOD
  87 #define PLATFORMMETHOD_END      KOBJMETHOD_END
  88
  89 #define PLATFORM_DEF(name)      DATA_SET(platform_set, name)
  90
  91 #endif /* _MACHINE_PLATFORMVAR_H_ */