Home | History | Annotate | Line # | Download | only in acpi
acpi_power.c revision 1.15
      1  1.15  jruoho /* $NetBSD: acpi_power.c,v 1.15 2010/06/07 13:04:31 jruoho Exp $ */
      2   1.1  jruoho 
      3   1.1  jruoho /*-
      4   1.1  jruoho  * Copyright (c) 2009, 2010 The NetBSD Foundation, Inc.
      5   1.1  jruoho  * All rights reserved.
      6   1.1  jruoho  *
      7   1.1  jruoho  * This code is derived from software contributed to The NetBSD Foundation
      8   1.1  jruoho  * by Jukka Ruohonen.
      9   1.1  jruoho  *
     10   1.1  jruoho  * Redistribution and use in source and binary forms, with or without
     11   1.1  jruoho  * modification, are permitted provided that the following conditions
     12   1.1  jruoho  * are met:
     13   1.1  jruoho  * 1. Redistributions of source code must retain the above copyright
     14   1.1  jruoho  *    notice, this list of conditions and the following disclaimer.
     15   1.1  jruoho  * 2. Redistributions in binary form must reproduce the above copyright
     16   1.1  jruoho  *    notice, this list of conditions and the following disclaimer in the
     17   1.1  jruoho  *    documentation and/or other materials provided with the distribution.
     18   1.1  jruoho  *
     19   1.1  jruoho  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     20   1.1  jruoho  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     21   1.1  jruoho  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     22   1.1  jruoho  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     23   1.1  jruoho  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     24   1.1  jruoho  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     25   1.1  jruoho  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     26   1.1  jruoho  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     27   1.1  jruoho  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     28   1.1  jruoho  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     29   1.1  jruoho  * POSSIBILITY OF SUCH DAMAGE.
     30   1.1  jruoho  */
     31   1.1  jruoho 
     32   1.1  jruoho /*-
     33   1.1  jruoho  * Copyright (c) 2001 Michael Smith
     34   1.1  jruoho  * All rights reserved.
     35   1.1  jruoho  *
     36   1.1  jruoho  * Redistribution and use in source and binary forms, with or without
     37   1.1  jruoho  * modification, are permitted provided that the following conditions
     38   1.1  jruoho  * are met:
     39   1.1  jruoho  * 1. Redistributions of source code must retain the above copyright
     40   1.1  jruoho  *    notice, this list of conditions and the following disclaimer.
     41   1.1  jruoho  * 2. Redistributions in binary form must reproduce the above copyright
     42   1.1  jruoho  *    notice, this list of conditions and the following disclaimer in the
     43   1.1  jruoho  *    documentation and/or other materials provided with the distribution.
     44   1.1  jruoho  *
     45   1.1  jruoho  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
     46   1.1  jruoho  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     47   1.1  jruoho  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     48   1.1  jruoho  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
     49   1.1  jruoho  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     50   1.1  jruoho  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     51   1.1  jruoho  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     52   1.1  jruoho  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     53   1.1  jruoho  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     54   1.1  jruoho  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     55   1.1  jruoho  * SUCH DAMAGE.
     56   1.1  jruoho  */
     57   1.1  jruoho 
     58   1.1  jruoho #include <sys/cdefs.h>
     59  1.15  jruoho __KERNEL_RCSID(0, "$NetBSD: acpi_power.c,v 1.15 2010/06/07 13:04:31 jruoho Exp $");
     60   1.1  jruoho 
     61   1.1  jruoho #include <sys/param.h>
     62   1.1  jruoho #include <sys/kmem.h>
     63   1.1  jruoho #include <sys/mutex.h>
     64   1.4  jruoho #include <sys/sysctl.h>
     65   1.1  jruoho 
     66   1.1  jruoho #include <dev/acpi/acpireg.h>
     67   1.1  jruoho #include <dev/acpi/acpivar.h>
     68   1.1  jruoho #include <dev/acpi/acpi_power.h>
     69   1.1  jruoho 
     70   1.1  jruoho #define _COMPONENT			ACPI_BUS_COMPONENT
     71   1.1  jruoho ACPI_MODULE_NAME			("acpi_power")
     72   1.1  jruoho 
     73  1.11  jruoho #define	ACPI_STA_POW_OFF		0x00
     74  1.11  jruoho #define	ACPI_STA_POW_ON			0x01
     75  1.11  jruoho 
     76   1.1  jruoho /*
     77   1.1  jruoho  * References.
     78   1.1  jruoho  */
     79   1.1  jruoho struct acpi_power_ref {
     80   1.1  jruoho 	ACPI_HANDLE			ref_handle;
     81   1.1  jruoho 
     82   1.1  jruoho 	SIMPLEQ_ENTRY(acpi_power_ref)	ref_list;
     83   1.1  jruoho };
     84   1.1  jruoho 
     85   1.1  jruoho /*
     86   1.1  jruoho  * Resources.
     87   1.1  jruoho  */
     88   1.1  jruoho struct acpi_power_res {
     89   1.1  jruoho 	ACPI_HANDLE			res_handle;
     90   1.1  jruoho 	ACPI_INTEGER			res_level;
     91   1.1  jruoho 	ACPI_INTEGER			res_order;
     92   1.1  jruoho 	char				res_name[5];
     93   1.1  jruoho 	kmutex_t			res_mutex;
     94   1.1  jruoho 
     95   1.1  jruoho 	TAILQ_ENTRY(acpi_power_res)	res_list;
     96   1.1  jruoho 	SIMPLEQ_HEAD(, acpi_power_ref)	ref_head;
     97   1.1  jruoho };
     98   1.1  jruoho 
     99   1.1  jruoho static TAILQ_HEAD(, acpi_power_res) res_head =
    100   1.1  jruoho 	TAILQ_HEAD_INITIALIZER(res_head);
    101   1.1  jruoho 
    102   1.4  jruoho static const struct sysctlnode	*anode = NULL;
    103   1.4  jruoho 
    104   1.1  jruoho static struct acpi_power_res	*acpi_power_res_init(ACPI_HANDLE);
    105   1.1  jruoho static struct acpi_power_res	*acpi_power_res_get(ACPI_HANDLE);
    106   1.1  jruoho 
    107   1.1  jruoho static ACPI_STATUS	 acpi_power_get_direct(struct acpi_devnode *);
    108   1.1  jruoho static ACPI_STATUS	 acpi_power_get_indirect(struct acpi_devnode *);
    109   1.1  jruoho static ACPI_STATUS	 acpi_power_switch(struct acpi_devnode *,
    110   1.1  jruoho 						   int, bool);
    111   1.1  jruoho static ACPI_STATUS	 acpi_power_res_on(ACPI_OBJECT *, void *);
    112   1.1  jruoho static ACPI_STATUS	 acpi_power_res_off(ACPI_OBJECT *, void *);
    113   1.1  jruoho static ACPI_STATUS	 acpi_power_res_ref(struct acpi_power_res *,
    114   1.1  jruoho 					    ACPI_HANDLE);
    115   1.1  jruoho static ACPI_STATUS	 acpi_power_res_deref(struct acpi_power_res *,
    116   1.1  jruoho 					      ACPI_HANDLE);
    117   1.1  jruoho static ACPI_STATUS	 acpi_power_res_sta(ACPI_OBJECT *, void *);
    118   1.1  jruoho 
    119   1.1  jruoho static ACPI_OBJECT	*acpi_power_pkg_get(ACPI_HANDLE, int);
    120   1.4  jruoho static int		 acpi_power_sysctl(SYSCTLFN_ARGS);
    121   1.1  jruoho static const char	*acpi_xname(ACPI_HANDLE);
    122   1.1  jruoho 
    123   1.1  jruoho static struct acpi_power_res *
    124   1.1  jruoho acpi_power_res_init(ACPI_HANDLE hdl)
    125   1.1  jruoho {
    126   1.1  jruoho 	struct acpi_power_res *tmp = NULL;
    127   1.1  jruoho 	struct acpi_power_res *res = NULL;
    128   1.1  jruoho 	ACPI_OBJECT *obj;
    129   1.1  jruoho 	ACPI_BUFFER buf;
    130   1.1  jruoho 	ACPI_STATUS rv;
    131   1.1  jruoho 
    132   1.1  jruoho 	rv = acpi_eval_struct(hdl, NULL, &buf);
    133   1.1  jruoho 
    134   1.1  jruoho 	if (ACPI_FAILURE(rv))
    135   1.1  jruoho 		goto out;
    136   1.1  jruoho 
    137   1.1  jruoho 	obj = buf.Pointer;
    138   1.1  jruoho 
    139   1.1  jruoho 	if (obj->Type != ACPI_TYPE_POWER) {
    140   1.1  jruoho 		rv = AE_TYPE;
    141   1.1  jruoho 		goto out;
    142   1.1  jruoho 	}
    143   1.1  jruoho 
    144   1.1  jruoho 	res = kmem_zalloc(sizeof(*res), KM_SLEEP);
    145   1.1  jruoho 
    146   1.1  jruoho 	if (res == NULL) {
    147   1.1  jruoho 		rv = AE_NO_MEMORY;
    148   1.1  jruoho 		goto out;
    149   1.1  jruoho 	}
    150   1.1  jruoho 
    151   1.1  jruoho 	res->res_handle = hdl;
    152   1.1  jruoho 	res->res_level = obj->PowerResource.SystemLevel;
    153   1.1  jruoho 	res->res_order = obj->PowerResource.ResourceOrder;
    154   1.1  jruoho 
    155   1.1  jruoho 	(void)strlcpy(res->res_name,
    156   1.1  jruoho 	    acpi_xname(hdl), sizeof(res->res_name));
    157   1.1  jruoho 
    158   1.1  jruoho 	SIMPLEQ_INIT(&res->ref_head);
    159   1.1  jruoho 	mutex_init(&res->res_mutex, MUTEX_DEFAULT, IPL_NONE);
    160   1.1  jruoho 
    161   1.1  jruoho 	/*
    162   1.1  jruoho 	 * Power resources should be ordered.
    163   1.1  jruoho 	 *
    164   1.1  jruoho 	 * These *should* be enabled from low values to high
    165   1.1  jruoho 	 * values and disabled from high values to low values.
    166   1.1  jruoho 	 */
    167   1.1  jruoho 	TAILQ_FOREACH(tmp, &res_head, res_list) {
    168   1.1  jruoho 
    169   1.1  jruoho 		if (res->res_order < tmp->res_order) {
    170   1.1  jruoho 			TAILQ_INSERT_BEFORE(tmp, res, res_list);
    171   1.1  jruoho 			break;
    172   1.1  jruoho 		}
    173   1.1  jruoho 	}
    174   1.1  jruoho 
    175   1.1  jruoho 	if (tmp == NULL)
    176   1.1  jruoho 		TAILQ_INSERT_TAIL(&res_head, res, res_list);
    177   1.1  jruoho 
    178  1.15  jruoho 	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "%s added to the "
    179  1.15  jruoho 		"power resource queue\n", res->res_name));
    180  1.15  jruoho 
    181   1.1  jruoho out:
    182   1.1  jruoho 	if (buf.Pointer != NULL)
    183   1.1  jruoho 		ACPI_FREE(buf.Pointer);
    184   1.1  jruoho 
    185   1.1  jruoho 	return res;
    186   1.1  jruoho }
    187   1.1  jruoho 
    188   1.1  jruoho static struct acpi_power_res *
    189   1.1  jruoho acpi_power_res_get(ACPI_HANDLE hdl)
    190   1.1  jruoho {
    191   1.1  jruoho 	struct acpi_power_res *res;
    192   1.1  jruoho 
    193   1.1  jruoho 	TAILQ_FOREACH(res, &res_head, res_list) {
    194   1.1  jruoho 
    195   1.1  jruoho 		if (res->res_handle == hdl)
    196   1.1  jruoho 			return res;
    197   1.1  jruoho 	}
    198   1.1  jruoho 
    199   1.1  jruoho 	return acpi_power_res_init(hdl);
    200   1.1  jruoho }
    201   1.1  jruoho 
    202   1.1  jruoho bool
    203   1.1  jruoho acpi_power_register(struct acpi_devnode *ad)
    204   1.1  jruoho {
    205   1.1  jruoho 
    206   1.1  jruoho 	KASSERT(ad != NULL && ad->ad_root != NULL);
    207   1.1  jruoho 
    208   1.1  jruoho 	if ((ad->ad_flags & ACPI_DEVICE_POWER) == 0)
    209   1.1  jruoho 		return false;
    210   1.1  jruoho 
    211   1.1  jruoho 	return true;
    212   1.1  jruoho }
    213   1.1  jruoho 
    214   1.1  jruoho void
    215   1.1  jruoho acpi_power_deregister(struct acpi_devnode *ad)
    216   1.1  jruoho {
    217   1.1  jruoho 	struct acpi_power_res *res;
    218   1.1  jruoho 
    219   1.1  jruoho 	KASSERT(ad != NULL && ad->ad_root != NULL);
    220   1.1  jruoho 
    221   1.1  jruoho 	if ((ad->ad_flags & ACPI_DEVICE_POWER) == 0)
    222   1.1  jruoho 		return;
    223   1.1  jruoho 
    224   1.1  jruoho 	/*
    225   1.1  jruoho 	 * Remove all references in each resource.
    226   1.1  jruoho 	 */
    227   1.1  jruoho 	TAILQ_FOREACH(res, &res_head, res_list)
    228   1.1  jruoho 	    (void)acpi_power_res_deref(res, ad->ad_handle);
    229   1.1  jruoho }
    230   1.1  jruoho 
    231   1.6  jruoho void
    232   1.6  jruoho acpi_power_deregister_from_handle(ACPI_HANDLE hdl)
    233   1.6  jruoho {
    234   1.7  jruoho 	struct acpi_devnode *ad = acpi_get_node(hdl);
    235   1.6  jruoho 
    236   1.7  jruoho 	if (ad == NULL)
    237   1.6  jruoho 		return;
    238   1.6  jruoho 
    239   1.7  jruoho 	acpi_power_deregister(ad);
    240   1.6  jruoho }
    241   1.6  jruoho 
    242   1.1  jruoho /*
    243   1.1  jruoho  * Get the D-state of an ACPI device node.
    244   1.1  jruoho  */
    245   1.1  jruoho bool
    246   1.1  jruoho acpi_power_get(struct acpi_devnode *ad, int *state)
    247   1.1  jruoho {
    248   1.1  jruoho 	ACPI_STATUS rv;
    249   1.1  jruoho 
    250   1.1  jruoho 	if ((ad->ad_flags & ACPI_DEVICE_POWER) == 0) {
    251   1.1  jruoho 		rv = AE_SUPPORT;
    252   1.1  jruoho 		goto fail;
    253   1.1  jruoho 	}
    254   1.1  jruoho 
    255  1.12  jruoho 	/*
    256  1.12  jruoho 	 * Because the _PSC control method, like _STA,
    257  1.12  jruoho 	 * is known to be implemented incorrectly in
    258  1.12  jruoho 	 * many systems, we first try to retrieve the
    259  1.12  jruoho 	 * power state indirectly via power resources.
    260  1.12  jruoho 	 */
    261   1.1  jruoho 	rv = acpi_power_get_indirect(ad);
    262   1.1  jruoho 
    263   1.1  jruoho 	if (ACPI_FAILURE(rv))
    264  1.12  jruoho 		rv = acpi_power_get_direct(ad);
    265  1.12  jruoho 
    266  1.12  jruoho 	if (ACPI_FAILURE(rv))
    267   1.1  jruoho 		goto fail;
    268   1.1  jruoho 
    269   1.1  jruoho 	KASSERT(ad->ad_state != ACPI_STATE_ERROR);
    270   1.1  jruoho 
    271   1.1  jruoho 	if (ad->ad_state < ACPI_STATE_D0 || ad->ad_state > ACPI_STATE_D3) {
    272   1.1  jruoho 		rv = AE_BAD_VALUE;
    273   1.1  jruoho 		goto fail;
    274   1.1  jruoho 	}
    275   1.1  jruoho 
    276   1.1  jruoho 	if (state != NULL)
    277   1.1  jruoho 		*state = ad->ad_state;
    278   1.1  jruoho 
    279   1.1  jruoho 	return true;
    280   1.1  jruoho 
    281   1.1  jruoho fail:
    282   1.1  jruoho 	ad->ad_state = ACPI_STATE_ERROR;
    283   1.1  jruoho 
    284   1.1  jruoho 	if (state != NULL)
    285   1.1  jruoho 		*state = ad->ad_state;
    286   1.1  jruoho 
    287   1.1  jruoho 	aprint_error_dev(ad->ad_root, "failed to get power state "
    288   1.1  jruoho 	    "for %s: %s\n", ad->ad_name, AcpiFormatException(rv));
    289   1.1  jruoho 
    290   1.1  jruoho 	return false;
    291   1.1  jruoho }
    292   1.1  jruoho 
    293   1.1  jruoho static ACPI_STATUS
    294   1.1  jruoho acpi_power_get_direct(struct acpi_devnode *ad)
    295   1.1  jruoho {
    296   1.1  jruoho 	ACPI_INTEGER val = 0;
    297   1.1  jruoho 	ACPI_STATUS rv;
    298   1.1  jruoho 
    299   1.1  jruoho 	rv = acpi_eval_integer(ad->ad_handle, "_PSC", &val);
    300   1.1  jruoho 
    301   1.1  jruoho 	KDASSERT((uint64_t)val < INT_MAX);
    302   1.1  jruoho 
    303   1.1  jruoho 	ad->ad_state = (int)val;
    304   1.1  jruoho 
    305   1.1  jruoho 	return rv;
    306   1.1  jruoho }
    307   1.1  jruoho 
    308   1.1  jruoho static ACPI_STATUS
    309   1.1  jruoho acpi_power_get_indirect(struct acpi_devnode *ad)
    310   1.1  jruoho {
    311   1.1  jruoho 	ACPI_OBJECT *pkg;
    312   1.1  jruoho 	ACPI_STATUS rv;
    313   1.1  jruoho 	int i;
    314   1.1  jruoho 
    315   1.1  jruoho 	CTASSERT(ACPI_STATE_D0 == 0 && ACPI_STATE_D1 == 1);
    316   1.1  jruoho 	CTASSERT(ACPI_STATE_D2 == 2 && ACPI_STATE_D3 == 3);
    317   1.1  jruoho 
    318   1.1  jruoho 	/*
    319   1.1  jruoho 	 * The device is in a given D-state if all resources are on.
    320   1.1  jruoho 	 * To derive this, evaluate all elements in each _PRx package
    321   1.1  jruoho 	 * (x = 0 ... 3) and break if the noted condition becomes true.
    322   1.1  jruoho 	 */
    323   1.1  jruoho 	for (ad->ad_state = ACPI_STATE_D3, i = 0; i < ACPI_STATE_D3; i++) {
    324   1.1  jruoho 
    325   1.1  jruoho 		pkg = acpi_power_pkg_get(ad->ad_handle, i);
    326   1.1  jruoho 
    327   1.1  jruoho 		if (pkg == NULL)
    328   1.1  jruoho 			continue;
    329   1.1  jruoho 
    330   1.1  jruoho 		/*
    331   1.1  jruoho 		 * For each element in the _PRx package, evaluate _STA
    332   1.1  jruoho 		 * and return AE_OK only if all power resources are on.
    333   1.1  jruoho 		 */
    334   1.1  jruoho 		rv = acpi_foreach_package_object(pkg, acpi_power_res_sta, ad);
    335   1.1  jruoho 
    336   1.9  jruoho 		if (ACPI_FAILURE(rv) && rv != AE_CTRL_FALSE)
    337   1.1  jruoho 			goto out;
    338   1.1  jruoho 
    339   1.1  jruoho 		if (ACPI_SUCCESS(rv)) {
    340   1.1  jruoho 			ad->ad_state = i;
    341   1.1  jruoho 			goto out;
    342   1.1  jruoho 		}
    343   1.1  jruoho 
    344   1.1  jruoho 		ACPI_FREE(pkg); pkg = NULL;
    345   1.1  jruoho 	}
    346   1.1  jruoho 
    347   1.1  jruoho 	KASSERT(ad->ad_state == ACPI_STATE_D3);
    348   1.1  jruoho 
    349   1.1  jruoho 	return AE_OK;
    350   1.1  jruoho 
    351   1.1  jruoho out:
    352   1.1  jruoho 	ACPI_FREE(pkg);
    353   1.1  jruoho 
    354   1.1  jruoho 	return rv;
    355   1.1  jruoho }
    356   1.1  jruoho 
    357   1.1  jruoho /*
    358   1.1  jruoho  * Set the D-state of an ACPI device node.
    359   1.1  jruoho  */
    360   1.1  jruoho bool
    361   1.1  jruoho acpi_power_set(struct acpi_devnode *ad, int state)
    362   1.1  jruoho {
    363   1.1  jruoho 	ACPI_STATUS rv;
    364   1.1  jruoho 	char path[5];
    365   1.1  jruoho 	int old;
    366   1.1  jruoho 
    367   1.1  jruoho 	KASSERT(ad != NULL && ad->ad_root != NULL);
    368   1.1  jruoho 
    369  1.13  jruoho 	if ((ad->ad_flags & ACPI_DEVICE_POWER) == 0) {
    370  1.14  jruoho 		rv = AE_SUPPORT;
    371  1.14  jruoho 		goto fail;
    372  1.13  jruoho 	}
    373  1.13  jruoho 
    374   1.1  jruoho 	if (state < ACPI_STATE_D0 || state > ACPI_STATE_D3) {
    375   1.1  jruoho 		rv = AE_BAD_PARAMETER;
    376   1.1  jruoho 		goto fail;
    377   1.1  jruoho 	}
    378   1.1  jruoho 
    379   1.1  jruoho 	if (acpi_power_get(ad, &old) != true) {
    380   1.1  jruoho 		rv = AE_NOT_FOUND;
    381   1.1  jruoho 		goto fail;
    382   1.1  jruoho 	}
    383   1.1  jruoho 
    384   1.1  jruoho 	KASSERT(ad->ad_state == old);
    385   1.1  jruoho 	KASSERT(ad->ad_state != ACPI_STATE_ERROR);
    386   1.1  jruoho 
    387   1.1  jruoho 	if (ad->ad_state == state) {
    388   1.1  jruoho 		rv = AE_ALREADY_EXISTS;
    389   1.1  jruoho 		goto fail;
    390   1.1  jruoho 	}
    391   1.1  jruoho 
    392   1.1  jruoho 	/*
    393   1.1  jruoho 	 * It is only possible to go to D0 ("on") from D3 ("off").
    394   1.1  jruoho 	 */
    395   1.1  jruoho 	if (ad->ad_state == ACPI_STATE_D3 && state != ACPI_STATE_D0) {
    396   1.1  jruoho 		rv = AE_BAD_PARAMETER;
    397   1.1  jruoho 		goto fail;
    398   1.1  jruoho 	}
    399   1.1  jruoho 
    400   1.1  jruoho 	/*
    401  1.12  jruoho 	 * We first sweep through the resources required for the target
    402  1.12  jruoho 	 * state, turning things on and building references. After this
    403  1.12  jruoho 	 * we dereference the resources required for the current state,
    404   1.1  jruoho 	 * turning the resources off as we go.
    405   1.1  jruoho 	 */
    406   1.1  jruoho 	rv = acpi_power_switch(ad, state, true);
    407   1.1  jruoho 
    408  1.12  jruoho 	if (ACPI_FAILURE(rv) && rv != AE_CTRL_CONTINUE)
    409   1.1  jruoho 		goto fail;
    410   1.1  jruoho 
    411   1.1  jruoho 	rv = acpi_power_switch(ad, ad->ad_state, false);
    412   1.1  jruoho 
    413  1.12  jruoho 	if (ACPI_FAILURE(rv) && rv != AE_CTRL_CONTINUE)
    414   1.1  jruoho 		goto fail;
    415   1.1  jruoho 
    416   1.1  jruoho 	/*
    417  1.12  jruoho 	 * Last but not least, invoke the power state switch method,
    418  1.12  jruoho 	 * if available. Because some systems use only _PSx for the
    419  1.12  jruoho 	 * power state transitions, we do this even if there is no _PRx.
    420   1.1  jruoho 	 */
    421   1.1  jruoho 	(void)snprintf(path, sizeof(path), "_PS%d", state);
    422   1.1  jruoho 	(void)AcpiEvaluateObject(ad->ad_handle, path, NULL, NULL);
    423   1.1  jruoho 
    424   1.1  jruoho 	aprint_debug_dev(ad->ad_root, "%s turned from "
    425   1.1  jruoho 	    "D%d to D%d\n", ad->ad_name, old, state);
    426   1.1  jruoho 
    427  1.12  jruoho 	ad->ad_state = state;
    428  1.12  jruoho 
    429   1.1  jruoho 	return true;
    430   1.1  jruoho 
    431   1.1  jruoho fail:
    432   1.2  jruoho 	ad->ad_state = ACPI_STATE_ERROR;
    433   1.1  jruoho 
    434  1.14  jruoho 	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "failed to set power state to D%d "
    435  1.14  jruoho 		"for %s: %s\n", state, ad->ad_name, AcpiFormatException(rv)));
    436   1.1  jruoho 
    437   1.2  jruoho 	return false;
    438   1.1  jruoho }
    439   1.1  jruoho 
    440   1.1  jruoho /*
    441   1.1  jruoho  * Set the D-state of an ACPI device node from a handle.
    442   1.1  jruoho  */
    443   1.1  jruoho bool
    444   1.1  jruoho acpi_power_set_from_handle(ACPI_HANDLE hdl, int state)
    445   1.1  jruoho {
    446   1.7  jruoho 	struct acpi_devnode *ad = acpi_get_node(hdl);
    447   1.1  jruoho 
    448   1.7  jruoho 	if (ad == NULL)
    449   1.1  jruoho 		return false;
    450   1.1  jruoho 
    451   1.7  jruoho 	return acpi_power_set(ad, state);
    452   1.1  jruoho }
    453   1.1  jruoho 
    454   1.1  jruoho static ACPI_STATUS
    455   1.1  jruoho acpi_power_switch(struct acpi_devnode *ad, int state, bool on)
    456   1.1  jruoho {
    457   1.1  jruoho 	ACPI_OBJECT *pkg;
    458   1.1  jruoho 	ACPI_STATUS rv;
    459   1.1  jruoho 
    460   1.1  jruoho 	pkg = acpi_power_pkg_get(ad->ad_handle, state);
    461   1.1  jruoho 
    462   1.1  jruoho 	if (pkg == NULL)
    463  1.12  jruoho 		return AE_CTRL_CONTINUE;
    464   1.1  jruoho 
    465   1.1  jruoho 	if (on != false)
    466   1.1  jruoho 		rv = acpi_foreach_package_object(pkg, acpi_power_res_on, ad);
    467   1.1  jruoho 	else
    468   1.1  jruoho 		rv = acpi_foreach_package_object(pkg, acpi_power_res_off, ad);
    469   1.1  jruoho 
    470  1.12  jruoho 	if (rv == AE_CTRL_CONTINUE)
    471  1.12  jruoho 		rv = AE_ERROR;
    472  1.12  jruoho 
    473   1.1  jruoho 	ACPI_FREE(pkg);
    474   1.1  jruoho 
    475   1.1  jruoho 	return rv;
    476   1.1  jruoho }
    477   1.1  jruoho 
    478   1.1  jruoho static ACPI_STATUS
    479   1.1  jruoho acpi_power_res_on(ACPI_OBJECT *elm, void *arg)
    480   1.1  jruoho {
    481   1.1  jruoho 	struct acpi_devnode *ad = arg;
    482   1.1  jruoho 	struct acpi_power_res *res;
    483   1.1  jruoho 	ACPI_HANDLE hdl;
    484   1.1  jruoho 	ACPI_STATUS rv;
    485   1.1  jruoho 
    486   1.1  jruoho 	/*
    487   1.1  jruoho 	 * For each element in the _PRx package, first
    488   1.1  jruoho 	 * fetch the reference handle and then search
    489   1.1  jruoho 	 * for this handle from the power resource list.
    490   1.1  jruoho 	 */
    491   1.1  jruoho 	rv = acpi_eval_reference_handle(elm, &hdl);
    492   1.1  jruoho 
    493   1.1  jruoho 	if (ACPI_FAILURE(rv))
    494   1.1  jruoho 		return rv;
    495   1.1  jruoho 
    496   1.1  jruoho 	res = acpi_power_res_get(hdl);
    497   1.1  jruoho 
    498   1.1  jruoho 	if (res == NULL)
    499   1.1  jruoho 		return AE_NOT_FOUND;
    500   1.1  jruoho 
    501   1.1  jruoho 	/*
    502   1.1  jruoho 	 * Reference the resource.
    503   1.1  jruoho 	 */
    504   1.1  jruoho 	rv = acpi_power_res_ref(res, ad->ad_handle);
    505   1.1  jruoho 
    506   1.1  jruoho 	if (ACPI_FAILURE(rv))
    507   1.1  jruoho 		return rv;
    508   1.1  jruoho 
    509   1.1  jruoho 	/*
    510   1.1  jruoho 	 * Turn the resource on.
    511   1.1  jruoho 	 */
    512   1.1  jruoho 	return AcpiEvaluateObject(res->res_handle, "_ON", NULL, NULL);
    513   1.1  jruoho }
    514   1.1  jruoho 
    515   1.1  jruoho static ACPI_STATUS
    516   1.1  jruoho acpi_power_res_off(ACPI_OBJECT *elm, void *arg)
    517   1.1  jruoho {
    518   1.1  jruoho 	struct acpi_devnode *ad = arg;
    519   1.1  jruoho 	struct acpi_power_res *res;
    520   1.1  jruoho 	ACPI_HANDLE hdl;
    521   1.1  jruoho 	ACPI_STATUS rv;
    522   1.1  jruoho 
    523   1.1  jruoho 	rv = acpi_eval_reference_handle(elm, &hdl);
    524   1.1  jruoho 
    525   1.1  jruoho 	if (ACPI_FAILURE(rv))
    526   1.1  jruoho 		return rv;
    527   1.1  jruoho 
    528   1.1  jruoho 	res = acpi_power_res_get(hdl);
    529   1.1  jruoho 
    530   1.1  jruoho 	if (res == NULL)
    531   1.1  jruoho 		return AE_NOT_FOUND;
    532   1.1  jruoho 
    533   1.1  jruoho 	rv = acpi_power_res_deref(res, ad->ad_handle);
    534   1.1  jruoho 
    535   1.1  jruoho 	if (ACPI_FAILURE(rv))
    536   1.1  jruoho 		return rv;
    537   1.1  jruoho 
    538   1.1  jruoho 	return AcpiEvaluateObject(res->res_handle, "_OFF", NULL, NULL);
    539   1.1  jruoho }
    540   1.1  jruoho 
    541   1.1  jruoho static ACPI_STATUS
    542   1.1  jruoho acpi_power_res_ref(struct acpi_power_res *res, ACPI_HANDLE hdl)
    543   1.1  jruoho {
    544   1.1  jruoho 	struct acpi_power_ref *ref, *tmp;
    545   1.1  jruoho 
    546   1.1  jruoho 	ref = kmem_zalloc(sizeof(*ref), KM_SLEEP);
    547   1.1  jruoho 
    548   1.1  jruoho 	if (ref == NULL)
    549   1.1  jruoho 		return AE_NO_MEMORY;
    550   1.1  jruoho 
    551   1.1  jruoho 	mutex_enter(&res->res_mutex);
    552   1.1  jruoho 
    553   1.1  jruoho 	SIMPLEQ_FOREACH(tmp, &res->ref_head, ref_list) {
    554   1.1  jruoho 
    555   1.1  jruoho 		if (tmp->ref_handle == hdl)
    556   1.1  jruoho 			goto out;
    557   1.1  jruoho 	}
    558   1.1  jruoho 
    559   1.1  jruoho 	ref->ref_handle = hdl;
    560   1.1  jruoho 	SIMPLEQ_INSERT_TAIL(&res->ref_head, ref, ref_list);
    561   1.1  jruoho 	mutex_exit(&res->res_mutex);
    562   1.1  jruoho 
    563   1.8  jruoho 	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "%s referenced "
    564   1.8  jruoho 		"by %s?\n", res->res_name, acpi_xname(hdl)));
    565   1.1  jruoho 
    566   1.1  jruoho 	return AE_OK;
    567   1.1  jruoho 
    568   1.1  jruoho out:
    569   1.1  jruoho 	mutex_exit(&res->res_mutex);
    570   1.1  jruoho 	kmem_free(ref, sizeof(*ref));
    571   1.1  jruoho 
    572   1.8  jruoho 	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "%s already referenced "
    573   1.8  jruoho 		"by %s?\n", res->res_name, acpi_xname(hdl)));
    574   1.1  jruoho 
    575   1.1  jruoho 	return AE_OK;
    576   1.1  jruoho }
    577   1.1  jruoho 
    578   1.1  jruoho static ACPI_STATUS
    579   1.1  jruoho acpi_power_res_deref(struct acpi_power_res *res, ACPI_HANDLE hdl)
    580   1.1  jruoho {
    581   1.1  jruoho 	struct acpi_power_ref *ref;
    582   1.1  jruoho 
    583   1.1  jruoho 	mutex_enter(&res->res_mutex);
    584   1.1  jruoho 
    585   1.1  jruoho 	if (SIMPLEQ_EMPTY(&res->ref_head) != 0) {
    586   1.1  jruoho 		mutex_exit(&res->res_mutex);
    587   1.1  jruoho 		return AE_OK;
    588   1.1  jruoho 	}
    589   1.1  jruoho 
    590   1.1  jruoho 	SIMPLEQ_FOREACH(ref, &res->ref_head, ref_list) {
    591   1.1  jruoho 
    592   1.1  jruoho 		if (ref->ref_handle == hdl) {
    593   1.1  jruoho 			SIMPLEQ_REMOVE(&res->ref_head,
    594   1.1  jruoho 			    ref, acpi_power_ref, ref_list);
    595   1.1  jruoho 			mutex_exit(&res->res_mutex);
    596   1.1  jruoho 			kmem_free(ref, sizeof(*ref));
    597   1.1  jruoho 			mutex_enter(&res->res_mutex);
    598   1.1  jruoho 			break;
    599   1.1  jruoho 		}
    600   1.1  jruoho 	}
    601   1.1  jruoho 
    602   1.1  jruoho 	/*
    603   1.1  jruoho 	 * If the queue remains non-empty,
    604   1.1  jruoho 	 * something else is using the resource
    605   1.1  jruoho 	 * and hence it can not be turned off.
    606   1.1  jruoho 	 */
    607   1.1  jruoho 	if (SIMPLEQ_EMPTY(&res->ref_head) == 0) {
    608   1.1  jruoho 		mutex_exit(&res->res_mutex);
    609   1.1  jruoho 		return AE_ABORT_METHOD;
    610   1.1  jruoho 	}
    611   1.1  jruoho 
    612   1.1  jruoho 	mutex_exit(&res->res_mutex);
    613   1.1  jruoho 
    614   1.8  jruoho 	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "%s dereferenced "
    615   1.8  jruoho 		"by %s?\n", res->res_name, acpi_xname(hdl)));
    616   1.1  jruoho 
    617   1.1  jruoho 	return AE_OK;
    618   1.1  jruoho }
    619   1.1  jruoho 
    620   1.1  jruoho static ACPI_STATUS
    621   1.1  jruoho acpi_power_res_sta(ACPI_OBJECT *elm, void *arg)
    622   1.1  jruoho {
    623   1.1  jruoho 	ACPI_INTEGER val;
    624   1.1  jruoho 	ACPI_HANDLE hdl;
    625   1.1  jruoho 	ACPI_STATUS rv;
    626   1.1  jruoho 
    627   1.1  jruoho 	rv = acpi_eval_reference_handle(elm, &hdl);
    628   1.1  jruoho 
    629   1.1  jruoho 	if (ACPI_FAILURE(rv))
    630   1.1  jruoho 		goto fail;
    631   1.1  jruoho 
    632   1.1  jruoho 	rv = acpi_eval_integer(hdl, "_STA", &val);
    633   1.1  jruoho 
    634   1.1  jruoho 	if (ACPI_FAILURE(rv))
    635   1.1  jruoho 		goto fail;
    636   1.1  jruoho 
    637   1.1  jruoho 	KDASSERT((uint64_t)val < INT_MAX);
    638   1.1  jruoho 
    639   1.1  jruoho 	if ((int)val != ACPI_STA_POW_ON && (int)val != ACPI_STA_POW_OFF)
    640   1.1  jruoho 		return AE_BAD_VALUE;
    641   1.1  jruoho 
    642   1.1  jruoho 	if ((int)val != ACPI_STA_POW_ON)
    643   1.9  jruoho 		return AE_CTRL_FALSE;		/* XXX: Not an error. */
    644   1.1  jruoho 
    645   1.1  jruoho 	return AE_OK;
    646   1.1  jruoho 
    647   1.1  jruoho fail:
    648  1.10  jruoho 	if (rv == AE_CTRL_FALSE)
    649   1.1  jruoho 		rv = AE_ERROR;
    650   1.1  jruoho 
    651   1.8  jruoho 	ACPI_DEBUG_PRINT((ACPI_DB_DEBUG_OBJECT, "failed to evaluate _STA "
    652   1.8  jruoho 		"for %s: %s\n", acpi_xname(hdl), AcpiFormatException(rv)));
    653   1.1  jruoho 
    654   1.1  jruoho 	return rv;
    655   1.1  jruoho }
    656   1.1  jruoho 
    657   1.1  jruoho static ACPI_OBJECT *
    658   1.1  jruoho acpi_power_pkg_get(ACPI_HANDLE hdl, int state)
    659   1.1  jruoho {
    660   1.1  jruoho 	char path[5] = "_PR?";
    661   1.1  jruoho 	ACPI_OBJECT *obj;
    662   1.1  jruoho 	ACPI_BUFFER buf;
    663   1.1  jruoho 	ACPI_STATUS rv;
    664   1.1  jruoho 
    665   1.1  jruoho 	path[3] = '0' + state;
    666   1.1  jruoho 
    667   1.1  jruoho 	rv = acpi_eval_struct(hdl, path, &buf);
    668   1.1  jruoho 
    669   1.1  jruoho 	if (ACPI_FAILURE(rv))
    670   1.1  jruoho 		goto fail;
    671   1.1  jruoho 
    672   1.1  jruoho 	if (buf.Length == 0) {
    673   1.1  jruoho 		rv = AE_LIMIT;
    674   1.1  jruoho 		goto fail;
    675   1.1  jruoho 	}
    676   1.1  jruoho 
    677   1.1  jruoho 	obj = buf.Pointer;
    678   1.1  jruoho 
    679   1.1  jruoho 	if (obj->Type != ACPI_TYPE_PACKAGE) {
    680   1.1  jruoho 		rv = AE_TYPE;
    681   1.1  jruoho 		goto fail;
    682   1.1  jruoho 	}
    683   1.1  jruoho 
    684   1.1  jruoho 	if (obj->Package.Count == 0) {
    685   1.1  jruoho 		rv = AE_LIMIT;
    686   1.1  jruoho 		goto fail;
    687   1.1  jruoho 	}
    688   1.1  jruoho 
    689   1.1  jruoho 	return obj;
    690   1.1  jruoho 
    691   1.1  jruoho fail:
    692   1.1  jruoho 	if (buf.Pointer != NULL)
    693   1.1  jruoho 		ACPI_FREE(buf.Pointer);
    694   1.1  jruoho 
    695   1.8  jruoho 	ACPI_DEBUG_PRINT((ACPI_DB_DEBUG_OBJECT, "failed to evaluate %s for "
    696   1.8  jruoho 		"%s: %s\n", path, acpi_xname(hdl), AcpiFormatException(rv)));
    697   1.1  jruoho 
    698   1.1  jruoho 	return NULL;
    699   1.1  jruoho }
    700   1.1  jruoho 
    701   1.4  jruoho SYSCTL_SETUP(sysctl_acpi_power_setup, "sysctl hw.acpi.power subtree setup")
    702   1.4  jruoho {
    703   1.4  jruoho 	int err;
    704   1.4  jruoho 
    705   1.4  jruoho 	err = sysctl_createv(NULL, 0, NULL, &anode,
    706   1.4  jruoho 	    CTLFLAG_PERMANENT, CTLTYPE_NODE, "hw",
    707   1.4  jruoho 	    NULL, NULL, 0, NULL, 0,
    708   1.4  jruoho 	    CTL_HW, CTL_EOL);
    709   1.4  jruoho 
    710   1.4  jruoho 	if (err != 0)
    711   1.4  jruoho 		goto fail;
    712   1.4  jruoho 
    713   1.4  jruoho 	err = sysctl_createv(NULL, 0, &anode, &anode,
    714   1.4  jruoho 	    CTLFLAG_PERMANENT, CTLTYPE_NODE, "acpi",
    715   1.4  jruoho 	    NULL, NULL, 0, NULL, 0,
    716   1.4  jruoho 	    CTL_CREATE, CTL_EOL);
    717   1.4  jruoho 
    718   1.4  jruoho 	if (err != 0)
    719   1.4  jruoho 		goto fail;
    720   1.4  jruoho 
    721   1.4  jruoho 	err = sysctl_createv(NULL, 0, &anode, &anode,
    722   1.4  jruoho 	    CTLFLAG_PERMANENT, CTLTYPE_NODE,
    723   1.4  jruoho 	    "power", SYSCTL_DESCR("ACPI device power states"),
    724   1.4  jruoho 	    NULL, 0, NULL, 0,
    725   1.4  jruoho 	    CTL_CREATE, CTL_EOL);
    726   1.4  jruoho 
    727   1.4  jruoho 	if (err != 0)
    728   1.4  jruoho 		goto fail;
    729   1.4  jruoho 
    730   1.4  jruoho 	return;
    731   1.4  jruoho 
    732   1.4  jruoho fail:
    733   1.4  jruoho 	anode = NULL;
    734   1.4  jruoho }
    735   1.4  jruoho 
    736   1.4  jruoho void
    737   1.4  jruoho acpi_power_add(struct acpi_devnode *ad)
    738   1.4  jruoho {
    739   1.4  jruoho 	int err;
    740   1.4  jruoho 
    741   1.4  jruoho 	KASSERT(ad != NULL && ad->ad_root != NULL);
    742   1.4  jruoho 	KASSERT((ad->ad_flags & ACPI_DEVICE_POWER) != 0);
    743   1.4  jruoho 
    744   1.4  jruoho 	if (anode == NULL)
    745   1.4  jruoho 		return;
    746   1.4  jruoho 
    747   1.4  jruoho 	/*
    748   1.4  jruoho 	 * Make this read-only: because a single power resource
    749   1.4  jruoho 	 * may power multiple devices, it is unclear whether
    750   1.4  jruoho 	 * power resources should be controllable by an user.
    751   1.4  jruoho 	 */
    752   1.4  jruoho 	err = sysctl_createv(NULL, 0, &anode, NULL,
    753   1.4  jruoho 	    CTLFLAG_READONLY, CTLTYPE_STRING, ad->ad_name,
    754   1.5  jruoho 	    NULL, acpi_power_sysctl, 0, ad, 0,
    755   1.4  jruoho 	    CTL_CREATE, CTL_EOL);
    756   1.4  jruoho 
    757   1.4  jruoho 	if (err != 0)
    758   1.4  jruoho 		aprint_error_dev(ad->ad_root, "sysctl_createv"
    759   1.4  jruoho 		    "(hw.acpi.power.%s) failed (err %d)\n", ad->ad_name, err);
    760   1.4  jruoho }
    761   1.4  jruoho 
    762   1.4  jruoho static int
    763   1.4  jruoho acpi_power_sysctl(SYSCTLFN_ARGS)
    764   1.4  jruoho {
    765   1.5  jruoho 	struct acpi_devnode *ad;
    766   1.4  jruoho 	struct sysctlnode node;
    767   1.4  jruoho 	int err, state;
    768   1.4  jruoho 	char t[3];
    769   1.4  jruoho 
    770   1.4  jruoho 	node = *rnode;
    771   1.5  jruoho 	ad = rnode->sysctl_data;
    772   1.5  jruoho 
    773   1.5  jruoho 	if (acpi_power_get(ad, &state) != true)
    774   1.5  jruoho 		state = 0;
    775   1.4  jruoho 
    776   1.4  jruoho 	(void)memset(t, '\0', sizeof(t));
    777   1.4  jruoho 	(void)snprintf(t, sizeof(t), "D%d", state);
    778   1.4  jruoho 
    779   1.4  jruoho 	node.sysctl_data = &t;
    780   1.4  jruoho 
    781   1.4  jruoho 	err = sysctl_lookup(SYSCTLFN_CALL(&node));
    782   1.4  jruoho 
    783   1.4  jruoho 	if (err || newp == NULL)
    784   1.4  jruoho 		return err;
    785   1.4  jruoho 
    786   1.4  jruoho 	return 0;
    787   1.4  jruoho }
    788   1.4  jruoho 
    789   1.1  jruoho /*
    790   1.1  jruoho  * XXX: Move this to acpi_util.c by refactoring
    791   1.1  jruoho  *	acpi_name() to optionally return a single name.
    792   1.1  jruoho  */
    793   1.1  jruoho static const char *
    794   1.1  jruoho acpi_xname(ACPI_HANDLE hdl)
    795   1.1  jruoho {
    796   1.1  jruoho 	static char str[5];
    797   1.1  jruoho 	ACPI_BUFFER buf;
    798   1.1  jruoho 	ACPI_STATUS rv;
    799   1.1  jruoho 
    800   1.1  jruoho 	buf.Pointer = str;
    801   1.1  jruoho 	buf.Length = sizeof(str);
    802   1.1  jruoho 
    803   1.1  jruoho 	rv = AcpiGetName(hdl, ACPI_SINGLE_NAME, &buf);
    804   1.1  jruoho 
    805   1.1  jruoho 	if (ACPI_FAILURE(rv))
    806   1.1  jruoho 		return "????";
    807   1.1  jruoho 
    808   1.1  jruoho 	return str;
    809   1.1  jruoho }
    810