1.\" $NetBSD: powerhook_establish.9,v 1.15 2025/01/04 17:21:41 riastradh Exp $ 2.\" 3.\" Copyright (c) 1999 The NetBSD Foundation, Inc. 4.\" All rights reserved. 5.\" 6.\" This code is derived from software contributed to The NetBSD Foundation 7.\" by Lennart Augustsson. 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.\" 2. Redistributions in binary form must reproduce the above copyright 15.\" notice, this list of conditions and the following disclaimer in the 16.\" documentation and/or other materials provided with the distribution. 17.\" 18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 21.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28.\" POSSIBILITY OF SUCH DAMAGE. 29.\" 30.Dd December 30, 2024 31.Dt POWERHOOK_ESTABLISH 9 32.Os 33.Sh NAME 34.Nm powerhook_establish , 35.Nm powerhook_disestablish 36.Nd add or remove a power change hook 37.Sh SYNOPSIS 38.Ft void * 39.Fn powerhook_establish "const char *name" "void (*fn)(int why, void *a)" \ 40"void *arg" 41.Ft void 42.Fn powerhook_disestablish "void *cookie" 43.Sh DESCRIPTION 44.Em The 45.Nm 46.Em API is deprecated. 47See 48.Xr pmf 9 49for replacement functionality. 50.Pp 51The 52.Fn powerhook_establish 53function adds 54.Fa fn 55to the list of hooks invoked by 56.Xr dopowerhooks 9 57at power change. 58When invoked, the hook function 59.Fa fn 60will be passed the new power state as the first argument and 61.Fa arg 62as its second argument. 63.Pp 64The 65.Fn powerhook_disestablish 66function removes the hook described by the opaque pointer 67.Fa cookie 68from the list of hooks to be invoked at power change. 69If 70.Fa cookie 71is invalid, the result of 72.Fn powerhook_disestablish 73is undefined. 74.Pp 75Power hooks should be used to perform activities 76that must happen when the power situation to the computer changes. 77Because of the environment in which they are run, power hooks cannot 78rely on many system services (including file systems, and timeouts 79and other interrupt-driven services). 80The power hooks are typically executed from an interrupt context. 81.Pp 82The different reasons for calling the power hooks are: suspend, standby, and 83resume. 84The reason is reflected in the 85.Fa why 86argument and the values 87.Dv PWR_SOFTSUSPEND , 88.Dv PWR_SUSPEND , 89.Dv PWR_SOFTSTANDBY , 90.Dv PWR_STANDBY , 91.Dv PWR_SOFTRESUME , 92and 93.Dv PWR_RESUME . 94It calls with PWR_SOFTxxx in the normal priority level while the other 95callings are protected with 96.Xr splhigh 9 . 97At suspend the system is going to lose (almost) all power, standby retains 98some power (e.g., minimal power to USB devices), and at resume power is 99back to normal. 100.Sh RETURN VALUES 101If successful, 102.Fn powerhook_establish 103returns an opaque pointer describing the newly-established 104power hook. 105Otherwise, it returns NULL. 106.Sh SEE ALSO 107.Xr dopowerhooks 9 108