1 /*- 2 * Copyright 2017 Kyle Evans <[email protected]> 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 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 17 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 18 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 19 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 20 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 21 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 23 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 24 * 25 * $FreeBSD$ 26 */ 27 28 #ifndef DEV_SYSCON_H 29 #define DEV_SYSCON_H 30 31 #include "opt_platform.h" 32 33 #include <sys/types.h> 34 #include <sys/kobj.h> 35 #ifdef FDT 36 #include <dev/ofw/ofw_bus.h> 37 #endif 38 39 struct syscon { 40 KOBJ_FIELDS; 41 42 TAILQ_ENTRY(syscon) syscon_link; /* Global list entry */ 43 44 device_t pdev; /* provider device */ 45 #ifdef FDT 46 phandle_t ofw_node; /* OFW node for syscon */ 47 #endif 48 void *softc; /* provider softc */ 49 }; 50 51 /* 52 * Shorthands for constructing method tables. 53 */ 54 #define SYSCONMETHOD KOBJMETHOD 55 #define SYSCONMETHOD_END KOBJMETHOD_END 56 #define syscon_method_t kobj_method_t 57 #define syscon_class_t kobj_class_t 58 DECLARE_CLASS(syscon_class); 59 60 void *syscon_get_softc(struct syscon *syscon); 61 62 /* 63 * Provider interface 64 */ 65 struct syscon *syscon_create(device_t pdev, syscon_class_t syscon_class); 66 struct syscon *syscon_register(struct syscon *syscon); 67 int syscon_unregister(struct syscon *syscon); 68 69 #ifdef FDT 70 struct syscon *syscon_create_ofw_node(device_t pdev, 71 syscon_class_t syscon_class, phandle_t node); 72 phandle_t syscon_get_ofw_node(struct syscon *syscon); 73 int syscon_get_by_ofw_property(device_t consumer, phandle_t node, char *name, 74 struct syscon **syscon); 75 #endif 76 77 #endif /* DEV_SYSCON_H */ 78