Home | History | Annotate | Line # | Download | only in kern
subr_device.c revision 1.5
      1  1.5  thorpej /*	$NetBSD: subr_device.c,v 1.5 2021/02/04 23:29:16 thorpej Exp $	*/
      2  1.2    pooka 
      3  1.2    pooka /*
      4  1.5  thorpej  * Copyright (c) 2006, 2021 The NetBSD Foundation, Inc.
      5  1.2    pooka  * All rights reserved.
      6  1.2    pooka  *
      7  1.2    pooka  * Redistribution and use in source and binary forms, with or without
      8  1.2    pooka  * modification, are permitted provided that the following conditions
      9  1.2    pooka  * are met:
     10  1.2    pooka  * 1. Redistributions of source code must retain the above copyright
     11  1.2    pooka  *    notice, this list of conditions and the following disclaimer.
     12  1.2    pooka  * 2. Redistributions in binary form must reproduce the above copyright
     13  1.2    pooka  *    notice, this list of conditions and the following disclaimer in the
     14  1.2    pooka  *    documentation and/or other materials provided with the distribution.
     15  1.2    pooka  *
     16  1.2    pooka  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     17  1.2    pooka  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     18  1.2    pooka  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     19  1.2    pooka  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     20  1.2    pooka  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     21  1.2    pooka  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     22  1.2    pooka  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     23  1.2    pooka  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     24  1.2    pooka  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     25  1.2    pooka  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     26  1.2    pooka  * POSSIBILITY OF SUCH DAMAGE.
     27  1.2    pooka  */
     28  1.2    pooka 
     29  1.2    pooka #include <sys/cdefs.h>
     30  1.5  thorpej __KERNEL_RCSID(0, "$NetBSD: subr_device.c,v 1.5 2021/02/04 23:29:16 thorpej Exp $");
     31  1.2    pooka 
     32  1.2    pooka #include <sys/param.h>
     33  1.2    pooka #include <sys/device.h>
     34  1.2    pooka #include <sys/systm.h>
     35  1.2    pooka 
     36  1.3    pooka /* Root device. */
     37  1.3    pooka device_t			root_device;
     38  1.3    pooka 
     39  1.2    pooka /*
     40  1.2    pooka  * Accessor functions for the device_t type.
     41  1.2    pooka  */
     42  1.5  thorpej 
     43  1.2    pooka devclass_t
     44  1.2    pooka device_class(device_t dev)
     45  1.2    pooka {
     46  1.2    pooka 
     47  1.2    pooka 	return dev->dv_class;
     48  1.2    pooka }
     49  1.2    pooka 
     50  1.2    pooka cfdata_t
     51  1.2    pooka device_cfdata(device_t dev)
     52  1.2    pooka {
     53  1.2    pooka 
     54  1.2    pooka 	return dev->dv_cfdata;
     55  1.2    pooka }
     56  1.2    pooka 
     57  1.2    pooka cfdriver_t
     58  1.2    pooka device_cfdriver(device_t dev)
     59  1.2    pooka {
     60  1.2    pooka 
     61  1.2    pooka 	return dev->dv_cfdriver;
     62  1.2    pooka }
     63  1.2    pooka 
     64  1.2    pooka cfattach_t
     65  1.2    pooka device_cfattach(device_t dev)
     66  1.2    pooka {
     67  1.2    pooka 
     68  1.2    pooka 	return dev->dv_cfattach;
     69  1.2    pooka }
     70  1.2    pooka 
     71  1.2    pooka int
     72  1.2    pooka device_unit(device_t dev)
     73  1.2    pooka {
     74  1.2    pooka 
     75  1.2    pooka 	return dev->dv_unit;
     76  1.2    pooka }
     77  1.2    pooka 
     78  1.2    pooka const char *
     79  1.2    pooka device_xname(device_t dev)
     80  1.2    pooka {
     81  1.2    pooka 
     82  1.2    pooka 	return dev->dv_xname;
     83  1.2    pooka }
     84  1.2    pooka 
     85  1.2    pooka device_t
     86  1.2    pooka device_parent(device_t dev)
     87  1.2    pooka {
     88  1.2    pooka 
     89  1.2    pooka 	return dev->dv_parent;
     90  1.2    pooka }
     91  1.2    pooka 
     92  1.2    pooka bool
     93  1.2    pooka device_activation(device_t dev, devact_level_t level)
     94  1.2    pooka {
     95  1.2    pooka 	int active_flags;
     96  1.2    pooka 
     97  1.2    pooka 	active_flags = DVF_ACTIVE;
     98  1.2    pooka 	switch (level) {
     99  1.2    pooka 	case DEVACT_LEVEL_FULL:
    100  1.2    pooka 		active_flags |= DVF_CLASS_SUSPENDED;
    101  1.2    pooka 		/*FALLTHROUGH*/
    102  1.2    pooka 	case DEVACT_LEVEL_DRIVER:
    103  1.2    pooka 		active_flags |= DVF_DRIVER_SUSPENDED;
    104  1.2    pooka 		/*FALLTHROUGH*/
    105  1.2    pooka 	case DEVACT_LEVEL_BUS:
    106  1.2    pooka 		active_flags |= DVF_BUS_SUSPENDED;
    107  1.2    pooka 		break;
    108  1.2    pooka 	}
    109  1.2    pooka 
    110  1.2    pooka 	return (dev->dv_flags & active_flags) == DVF_ACTIVE;
    111  1.2    pooka }
    112  1.2    pooka 
    113  1.2    pooka bool
    114  1.2    pooka device_is_active(device_t dev)
    115  1.2    pooka {
    116  1.2    pooka 	int active_flags;
    117  1.2    pooka 
    118  1.2    pooka 	active_flags = DVF_ACTIVE;
    119  1.2    pooka 	active_flags |= DVF_CLASS_SUSPENDED;
    120  1.2    pooka 	active_flags |= DVF_DRIVER_SUSPENDED;
    121  1.2    pooka 	active_flags |= DVF_BUS_SUSPENDED;
    122  1.2    pooka 
    123  1.2    pooka 	return (dev->dv_flags & active_flags) == DVF_ACTIVE;
    124  1.2    pooka }
    125  1.2    pooka 
    126  1.2    pooka bool
    127  1.2    pooka device_is_enabled(device_t dev)
    128  1.2    pooka {
    129  1.2    pooka 	return (dev->dv_flags & DVF_ACTIVE) == DVF_ACTIVE;
    130  1.2    pooka }
    131  1.2    pooka 
    132  1.2    pooka bool
    133  1.2    pooka device_has_power(device_t dev)
    134  1.2    pooka {
    135  1.2    pooka 	int active_flags;
    136  1.2    pooka 
    137  1.2    pooka 	active_flags = DVF_ACTIVE | DVF_BUS_SUSPENDED;
    138  1.2    pooka 
    139  1.2    pooka 	return (dev->dv_flags & active_flags) == DVF_ACTIVE;
    140  1.2    pooka }
    141  1.2    pooka 
    142  1.2    pooka int
    143  1.2    pooka device_locator(device_t dev, u_int locnum)
    144  1.2    pooka {
    145  1.2    pooka 
    146  1.2    pooka 	KASSERT(dev->dv_locators != NULL);
    147  1.2    pooka 	return dev->dv_locators[locnum];
    148  1.2    pooka }
    149  1.2    pooka 
    150  1.2    pooka void *
    151  1.2    pooka device_private(device_t dev)
    152  1.2    pooka {
    153  1.2    pooka 
    154  1.2    pooka 	/*
    155  1.2    pooka 	 * The reason why device_private(NULL) is allowed is to simplify the
    156  1.2    pooka 	 * work of a lot of userspace request handlers (i.e., c/bdev
    157  1.2    pooka 	 * handlers) which grab cfdriver_t->cd_units[n].
    158  1.2    pooka 	 * It avoids having them test for it to be NULL and only then calling
    159  1.2    pooka 	 * device_private.
    160  1.2    pooka 	 */
    161  1.2    pooka 	return dev == NULL ? NULL : dev->dv_private;
    162  1.2    pooka }
    163  1.2    pooka 
    164  1.2    pooka prop_dictionary_t
    165  1.2    pooka device_properties(device_t dev)
    166  1.2    pooka {
    167  1.2    pooka 
    168  1.2    pooka 	return dev->dv_properties;
    169  1.2    pooka }
    170  1.2    pooka 
    171  1.2    pooka /*
    172  1.2    pooka  * device_is_a:
    173  1.2    pooka  *
    174  1.2    pooka  *	Returns true if the device is an instance of the specified
    175  1.2    pooka  *	driver.
    176  1.2    pooka  */
    177  1.2    pooka bool
    178  1.2    pooka device_is_a(device_t dev, const char *dname)
    179  1.2    pooka {
    180  1.4  thorpej 	if (dev == NULL || dev->dv_cfdriver == NULL) {
    181  1.4  thorpej 		return false;
    182  1.4  thorpej 	}
    183  1.2    pooka 
    184  1.2    pooka 	return strcmp(dev->dv_cfdriver->cd_name, dname) == 0;
    185  1.2    pooka }
    186  1.5  thorpej 
    187  1.5  thorpej /*
    188  1.5  thorpej  * device_attached_to_iattr:
    189  1.5  thorpej  *
    190  1.5  thorpej  *	Returns true if the device attached to the specified interface
    191  1.5  thorpej  *	attribute.
    192  1.5  thorpej  */
    193  1.5  thorpej bool
    194  1.5  thorpej device_attached_to_iattr(device_t dev, const char *iattr)
    195  1.5  thorpej {
    196  1.5  thorpej 	cfdata_t cfdata = device_cfdata(dev);
    197  1.5  thorpej 	const struct cfparent *pspec;
    198  1.5  thorpej 
    199  1.5  thorpej 	if (cfdata == NULL || (pspec = cfdata->cf_pspec) == NULL) {
    200  1.5  thorpej 		return false;
    201  1.5  thorpej 	}
    202  1.5  thorpej 
    203  1.5  thorpej 	return strcmp(pspec->cfp_iattr, iattr) == 0;
    204  1.5  thorpej }
    205