1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 /* 22 * Copyright 2008 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 26 #ifndef _SYS_EPM_H 27 #define _SYS_EPM_H 28 29 #pragma ident "%Z%%M% %I% %E% SMI" 30 31 #include <sys/pm.h> 32 #include <sys/dditypes.h> 33 #include <sys/devops.h> 34 #include <sys/ddi_impldefs.h> 35 #include <sys/taskq.h> 36 #include <sys/tzfile.h> 37 38 /* 39 * XXXX 40 * Do we really need this include? It may be leftover from early CPUPM code. 41 * #include <sys/processor.h> 42 */ 43 44 #ifdef __cplusplus 45 extern "C" { 46 #endif 47 48 #ifdef _KERNEL 49 50 /* 51 * epm.h: Function prototypes and data structs for kernel pm functions. 52 */ 53 54 void e_pm_props(dev_info_t *); 55 int e_new_pm_props(dev_info_t *); 56 57 #define PM_LEVEL_UPONLY (-2) /* only raise power level */ 58 #define PM_LEVEL_DOWNONLY (-3) /* only lower power level */ 59 #define PM_LEVEL_EXACT (-4) /* wants exact power level */ 60 61 /* 62 * Values used by e_pm_props and friends, found in devi_pm_flags 63 */ 64 #define PMC_NEEDS_SR 0x00001 /* do suspend/resume despite no "reg" */ 65 #define PMC_NO_SR 0x00002 /* don't suspend/resume despite "reg" */ 66 #define PMC_PARENTAL_SR 0x00004 /* call up tree to suspend/resume */ 67 #define PMC_WANTS_NOTIFY 0x00008 /* notify if child pwr level changes */ 68 #define PMC_BC 0x00010 /* no pm-components, backwards compat */ 69 #define PMC_COMPONENTS_DONE 0x00020 /* parsed pm-components */ 70 #define PMC_COMPONENTS_FAILED 0x00040 /* failed parsing pm-components */ 71 #define PMC_SUSPENDED 0x00080 /* device has been suspended */ 72 #define PMC_DEF_THRESH 0x00100 /* thresholds are default */ 73 #define PMC_DEV_THRESH 0x00200 /* SET_THRESHOLD ioctl seen */ 74 #define PMC_COMP_THRESH 0x00400 /* relative threshold set */ 75 #define PMC_NEXDEF_THRESH 0x00800 /* relative threshold set for nexus */ 76 #define PMC_NOPMKID 0x01000 /* non-pm'd child of pm'd parent */ 77 #define PMC_NO_INVOL 0x02000 /* no pm without driver's consent */ 78 #define PMC_VOLPMD 0x04000 /* went down voluntarily */ 79 #define PMC_SKIP_BRINGUP 0x08000 /* Skipped a dependency bringup */ 80 81 /* 82 * A node which is the console frame buffer, and should not be powered down 83 * automatically because the OBP driver doesn't know how to power it back up 84 * before using it (can remove this when prom calls back into kernel to do 85 * io to console). 86 */ 87 #define PMC_CONSOLE_FB 0x10000 /* console framebuffer */ 88 #define PMC_NOINVOL_DONE 0x20000 /* processed by pm_noinvol_specd() */ 89 #define PMC_DRIVER_REMOVED 0x40000 /* driver is removed */ 90 #define PMC_CPU_DEVICE 0x80000 /* device is a power manageable CPU */ 91 #define PMC_CPU_THRESH 0x100000 /* cpu threshold set */ 92 93 #define PMC_THRESH_ALL (PMC_DEF_THRESH | PMC_DEV_THRESH | \ 94 PMC_COMP_THRESH | PMC_NEXDEF_THRESH | PMC_CPU_THRESH) 95 #define PMC_THRESH_NONE ~(PMC_THRESH_ALL) 96 97 /* Flags for the component */ 98 #define PM_POWER_OP 0x00001 /* set power in process */ 99 #define PM_PHC_WHILE_SET_POWER 0x00002 /* phc and set power deadlock */ 100 101 /* 102 * One of these is attached to each devinfo that is autopm'd. 103 */ 104 typedef struct pm_scan { 105 int ps_idle_down; /* PMID_XXX flags */ 106 int ps_scan_flags; /* scan flags, defined below */ 107 timeout_id_t ps_scan_id; /* per dip scan timeout id */ 108 } pm_scan_t; 109 110 /* 111 * ps_scan_flags may take the following values, plus possibly 112 * more defined. 113 */ 114 #define PM_SCANNING 0x100 /* scanning: pm_scan_dev is active */ 115 #define PM_SCAN_AGAIN 0x200 116 #define PM_SCAN_STOP 0x400 117 #define PM_SCAN_DISPATCHED 0x800 118 119 #define PM_DEFAULT_MIN_SCAN ((clock_t)15) /* Minimum scan interval in sec */ 120 #define PM_CPU_MIN_SCAN ((clock_t)1) /* Minimum interval for CPUs */ 121 122 /* 123 * Power management component definitions, used for tracking idleness of 124 * devices. An array of these hangs off the devi_pm_components member of the 125 * dev_info struct (if initialized by driver and/or auto-pm) 126 * The array of these structs is followed in the same kmem_zalloc'd chunk by 127 * the names pointed to by the structs. 128 */ 129 130 /* 131 * This (sub-)struct contains all the info extracted from the pm-components 132 * property for each component (name of component, names and values of power 133 * levels supported). It is in a separate structure to allow it to be handled 134 * as a struct assignment. 135 */ 136 typedef struct pm_comp { 137 char *pmc_name; /* name of component */ 138 int pmc_numlevels; /* number of power levels supported */ 139 int *pmc_lvals; /* numerical values of levels */ 140 int *pmc_thresh; /* thresholds in secs, last INT_MAX */ 141 char **pmc_lnames; /* human readable names of levels */ 142 /* 143 * This part is just bookkeeping for the storage space involved above 144 * used for copying and freeing the struct members. This because C 145 * is really an assembler at heart. 146 */ 147 size_t pmc_name_sz; /* size of name string */ 148 char *pmc_lname_buf; /* buffer holding *pmc_lnames */ 149 size_t pmc_lnames_sz; /* total size of pmc_lname_buf */ 150 } pm_comp_t; 151 152 /* 153 * Here we have the rest of what we need to know about a component. 154 */ 155 typedef struct pm_component { 156 uint_t pmc_flags; /* flags this component */ 157 uint_t pmc_busycount; /* for nesting busy calls */ 158 time_t pmc_timestamp; /* timestamp */ 159 uint_t pmc_norm_pwr; /* normal power index (or value) */ 160 int pmc_cur_pwr; /* current power index (or value) */ 161 int pmc_phc_pwr; /* prev. value of curpwr (deadlock) */ 162 pm_comp_t pmc_comp; /* component description */ 163 } pm_component_t; 164 165 /* 166 * All members of this struct are protected by PM_LOCK_DIP(dip). 167 * 168 * kidsupcnt counts (the number of components of new-style children at non-zero 169 * level (unknown counts as non-zero)) + (the number of old-style children with 170 * component 0 at non-zero level) for parents that have not asked for 171 * notification. When kidsupcnt is 0 for a nexus node, then pm scans it, 172 * otherwise it leaves it alone. 173 * Parents that ask for notification always get get scanned, 174 * so we keep their kidsupcnt at zero. 175 */ 176 typedef struct pm_info { 177 uint_t pmi_dev_pm_state; /* PM state of a device */ 178 int pmi_clone; /* owner for direct pm'd devs */ 179 int pmi_levels[2]; /* storage space for 2 levels */ 180 int *pmi_lp; /* storage space for >2 levels */ 181 kcondvar_t pmi_cv; /* condvar for direct PM access */ 182 } pm_info_t; 183 184 /* 185 * Work request structure for the dependency processing thread. 186 */ 187 typedef struct pm_dep_wk { 188 int pdw_type; /* Type of request */ 189 int pdw_wait; /* caller waits for result */ 190 int pdw_done; /* set when req is done */ 191 int pdw_ret; /* return value to caller */ 192 int pdw_pwr; /* pwr level of keeper */ 193 kcondvar_t pdw_cv; /* cv to wake up caller */ 194 struct pm_dep_wk *pdw_next; /* next element */ 195 char *pdw_keeper; 196 char *pdw_kept; 197 } pm_dep_wk_t; 198 199 /* 200 * Types of work, depends on when it gets called: 201 */ 202 #define PM_DEP_WK_POWER_ON 1 /* power on */ 203 #define PM_DEP_WK_POWER_OFF 2 /* power off */ 204 #define PM_DEP_WK_DETACH 3 /* detach */ 205 #define PM_DEP_WK_REMOVE_DEP 4 /* dependency removed */ 206 #define PM_DEP_WK_BRINGUP_SELF 5 /* released from direct PM */ 207 #define PM_DEP_WK_RECORD_KEEPER 6 /* PM_ADD_DEPENDENT */ 208 #define PM_DEP_WK_RECORD_KEEPER_PROP 7 /* PM_ADD_DEPENDENT_PROP */ 209 #define PM_DEP_WK_KEPT 8 /* dep. work as a kept */ 210 #define PM_DEP_WK_KEEPER 9 /* dep. work as a keeper */ 211 #define PM_DEP_WK_ATTACH 10 /* when dip is attached */ 212 #define PM_DEP_WK_CHECK_KEPT 11 /* check if this is a kept */ 213 #define PM_DEP_WK_CPR_SUSPEND 12 /* Suspend dep. during CPR */ 214 #define PM_DEP_WK_CPR_RESUME 13 /* Resume dep. after CPR */ 215 216 /* 217 * Wait for dependency work to finish or not. 218 */ 219 #define PM_DEP_WAIT 1 220 #define PM_DEP_NOWAIT 0 221 222 typedef enum pm_canblock 223 { 224 PM_CANBLOCK_BLOCK, /* wait for controlling process action */ 225 PM_CANBLOCK_FAIL, /* don't wait, fail request */ 226 PM_CANBLOCK_BYPASS /* don't wait, ignore controlling process */ 227 } pm_canblock_t; 228 229 typedef enum pm_cpupm 230 { 231 PM_CPUPM_NOTSET, /* no specific treatment of CPU devices */ 232 PM_CPUPM_ENABLE, /* power manage CPU devices */ 233 PM_CPUPM_DISABLE /* do not power manage CPU devices */ 234 } pm_cpupm_t; 235 236 #define PPM(dip) ((dev_info_t *)DEVI(dip)->devi_pm_ppm) 237 238 /* 239 * The power request struct uses for the DDI_CTLOPS_POWER busctl. 240 * 241 * Note: When changing this enum it is necessary to maintain binary 242 * compatibility with older versions. To insure that, add new values only 243 * at the end and refrain from deleting any existing values. 244 */ 245 typedef enum { 246 PMR_SET_POWER = 1, /* called ddi_power (obsolete) */ 247 PMR_SUSPEND, /* parental suspend */ 248 PMR_RESUME, /* parental resume */ 249 PMR_PRE_SET_POWER, /* parent's "pre" notification */ 250 PMR_POST_SET_POWER, /* parent's "post" notification */ 251 PMR_PPM_SET_POWER, /* platform pm set power */ 252 PMR_PPM_ATTACH, /* ppm attach notify - unused */ 253 PMR_PPM_DETACH, /* ppm detach notify - unused */ 254 PMR_PPM_POWER_CHANGE_NOTIFY, /* ppm level change notify */ 255 PMR_REPORT_PMCAP, /* report pm capability */ 256 PMR_CHANGED_POWER, /* parent's power_has_changed notif. */ 257 PMR_PPM_PRE_PROBE, /* ppm pre probe notify */ 258 PMR_PPM_POST_PROBE, /* ppm post probe notify */ 259 PMR_PPM_PRE_ATTACH, /* ppm pre attach notify */ 260 PMR_PPM_POST_ATTACH, /* ppm post pm attach notify */ 261 PMR_PPM_PRE_DETACH, /* ppm pre pm detach notify */ 262 PMR_PPM_POST_DETACH, /* ppm post pm detach notify */ 263 PMR_PPM_UNMANAGE, /* device being unmanaged */ 264 PMR_PPM_PRE_RESUME, /* ppm resume notify */ 265 PMR_PPM_ALL_LOWEST, /* ppm all lowest power notify */ 266 PMR_PPM_LOCK_POWER, /* ppm lock power */ 267 PMR_PPM_UNLOCK_POWER, /* ppm unlock power */ 268 PMR_PPM_TRY_LOCK_POWER, /* ppm try lock power */ 269 PMR_PPM_INIT_CHILD, /* ppm init child notify */ 270 PMR_PPM_UNINIT_CHILD, /* ppm uninit child notify */ 271 PMR_PPM_POWER_LOCK_OWNER, /* ppm power lock owner's address */ 272 PMR_PPM_ENTER_SX, /* ppm: enter ACPI S[2-4] state */ 273 PMR_PPM_EXIT_SX, /* ppm: enter ACPI S[2-4] state */ 274 PMR_PPM_SEARCH_LIST /* ppm: search tuple list */ 275 } pm_request_type; 276 277 /* 278 * When changing the elements of the union below it is necessary to 279 * maintain binary compatibility with older versions. Refrain from 280 * deleting existing elements of the union or modifying their contents. 281 * Avoid increasing the total size of this structure if new elements 282 * must be added. 283 */ 284 typedef struct power_req { 285 pm_request_type request_type; 286 union req { 287 /* 288 * PMR_SET_POWER (obsolete) 289 */ 290 struct set_power_req { 291 dev_info_t *who; 292 int cmpt; 293 int level; 294 } set_power_req; 295 /* 296 * PMR_SUSPEND 297 */ 298 struct suspend_req { 299 dev_info_t *who; 300 ddi_detach_cmd_t cmd; 301 } suspend_req; 302 /* 303 * PMR_PPM_PRE_RESUME or PMR_RESUME 304 */ 305 struct resume_req { 306 dev_info_t *who; 307 ddi_attach_cmd_t cmd; 308 } resume_req; 309 /* 310 * PMR_PRE_SET_POWER 311 */ 312 struct pre_set_power_req { 313 dev_info_t *who; 314 int cmpt; 315 int old_level; 316 int new_level; 317 } pre_set_power_req; 318 /* 319 * PMR_POST_SET_POWER 320 */ 321 struct post_set_power_req { 322 dev_info_t *who; 323 int cmpt; 324 int old_level; 325 int new_level; 326 int result; /* driver's return */ 327 } post_set_power_req; 328 /* 329 * PMR_PPM_SET_POWER 330 */ 331 struct ppm_set_power_req { 332 dev_info_t *who; 333 int cmpt; 334 int old_level; 335 int new_level; 336 pm_canblock_t canblock; 337 void *cookie; 338 } ppm_set_power_req; 339 /* 340 * PMR_PPM_POWER_CHANGE_NOTIFY 341 */ 342 struct ppm_notify_level_req { 343 dev_info_t *who; 344 int cmpt; 345 int old_level; 346 int new_level; 347 } ppm_notify_level_req; 348 /* 349 * PMR_REPORT_PMCAP 350 */ 351 struct report_pmcap_req { 352 dev_info_t *who; 353 int cap; 354 void *arg; 355 } report_pmcap_req; 356 /* 357 * PMR_CHANGED_POWER 358 */ 359 struct changed_power_req { 360 dev_info_t *who; 361 int cmpt; 362 int old_level; 363 int new_level; 364 int result; 365 } changed_power_req; 366 /* 367 * PMR_PPM_PRE_PROBE, PMR_PPM_POST_PROBE, PMR_PPM_PRE_ATTACH, 368 * PMR_PPM_POST_ATTACH, PMR_PPM_PRE_DETACH, PMR_PPM_POST_DETACH 369 * PMR_PPM_INIT_CHILD, PMR_PPM_UNINIT_CHILD, or PMR_PPM_UNMANAGE 370 */ 371 struct ppm_config_req { 372 dev_info_t *who; 373 int result; /* post only */ 374 } ppm_config_req; 375 /* 376 * PMR_PPM_ALL_LOWEST 377 */ 378 struct ppm_all_lowest_req { 379 int mode; 380 } ppm_all_lowest_req; 381 /* 382 * PMR_PPM_LOCK_POWER, PMR_PPM_TRY_LOCK_POWER 383 */ 384 struct ppm_lock_power_req { 385 dev_info_t *who; 386 int *circp; 387 } ppm_lock_power_req; 388 /* 389 * PMR_PPM_UNLOCK_POWER 390 */ 391 struct ppm_unlock_power_req { 392 dev_info_t *who; 393 int circ; 394 } ppm_unlock_power_req; 395 /* 396 * PMR_PPM_POWER_LOCK_OWNER 397 */ 398 struct ppm_power_lock_owner_req { 399 dev_info_t *who; 400 kthread_t *owner; 401 } ppm_power_lock_owner_req; 402 /* 403 * PMR_PPM_POWER_ENTER_SX 404 */ 405 struct ppm_power_enter_sx_req { 406 int sx_state; /* S3, S4 */ 407 int test_point; /* test point */ 408 uint64_t wakephys; /* restart vector phys addr */ 409 void *psr; /* PSM (apic) state buffer */ 410 } ppm_power_enter_sx_req; 411 /* 412 * PMR_PPM_SEARCH_LIST 413 */ 414 struct ppm_search_list { 415 pm_searchargs_t *searchlist; 416 int result; 417 } ppm_search_list_req; 418 } req; 419 } power_req_t; 420 421 #define S3 3 422 #define S4 4 423 424 extern int cpr_test_point; 425 extern major_t cpr_device; 426 427 #define LOOP_BACK_NONE 0 428 #define LOOP_BACK_PASS 1 429 #define LOOP_BACK_FAIL 2 430 #define FORCE_SUSPEND_TO_RAM 3 431 #define DEVICE_SUSPEND_TO_RAM 4 432 433 /* 434 * Struct passed as arg to appm_ioctl 435 */ 436 typedef struct s3_args { 437 int s3a_state; /* S3, S4 */ 438 int s3a_test_point; /* test point */ 439 uint64_t s3a_wakephys; /* restart vector physical addr */ 440 void *s3a_psr; /* apic state save buffer */ 441 } s3a_t; 442 443 /* 444 * Structure used by the following bus_power operations: 445 * 446 * BUS_POWER_PRE_NOTIFICATION 447 * BUS_POWER_POST_NOTIFICATION 448 * BUS_POWER_CHILD_PWRCHG 449 */ 450 typedef struct pm_bp_child_pwrchg { 451 dev_info_t *bpc_dip; /* dip of the target device */ 452 char *bpc_path; /* path to the target device */ 453 int bpc_comp; /* component changing power */ 454 int bpc_olevel; /* old power level */ 455 int bpc_nlevel; /* new power level */ 456 void *bpc_private; /* PM framework private */ 457 } pm_bp_child_pwrchg_t; 458 459 /* 460 * Structure used by the BUS_POWER_NEXUS_PWRUP operation 461 */ 462 typedef struct pm_bp_nexus_pwrup { 463 dev_info_t *bpn_dip; /* dip of the nexus device */ 464 int bpn_comp; /* component powering up */ 465 int bpn_level; /* new power level */ 466 void *bpn_private; /* PM framework private */ 467 } pm_bp_nexus_pwrup_t; 468 469 /* 470 * Structure used by the BUS_POWER_HAS_CHANGED operation 471 */ 472 typedef struct pm_bp_has_changed { 473 dev_info_t *bphc_dip; /* dip of the target device */ 474 char *bphc_path; /* path to the target device */ 475 int bphc_comp; /* component changing power */ 476 int bphc_olevel; /* old power level */ 477 int bphc_nlevel; /* new power level */ 478 void *bphc_private; /* PM framework private */ 479 } pm_bp_has_changed_t; 480 481 /* 482 * Commands indicating which activity is requiring an 483 * update to the noinvol counters. 484 */ 485 #define PM_BP_NOINVOL_ATTACH 1 486 #define PM_BP_NOINVOL_DETACH 2 487 #define PM_BP_NOINVOL_REMDRV 3 488 #define PM_BP_NOINVOL_CFB 4 489 #define PM_BP_NOINVOL_POWER 5 490 491 /* 492 * Structure used by the BUS_POWER_NOINVOL operation. 493 */ 494 typedef struct pm_bp_noinvol { 495 dev_info_t *bpni_dip; /* dip of the target device */ 496 char *bpni_path; /* path to the target device */ 497 int bpni_cmd; /* how to update the counters */ 498 int bpni_volpmd; /* volpmd of target device */ 499 int bpni_wasvolpmd; /* whether to update volpmd */ 500 void *bpni_private; /* PM framework private */ 501 } pm_bp_noinvol_t; 502 503 /* 504 * This struct is used by the code that makes a PMR_PPM_SET_POWER request 505 * to ppm. Devices that changed power other than the primary device (which 506 * was requested) are passed back to the pm framework through this 507 * structure. 508 */ 509 typedef struct pm_ppm_devlist { 510 dev_info_t *ppd_who; 511 int ppd_cmpt; 512 int ppd_old_level; 513 int ppd_new_level; 514 struct pm_ppm_devlist *ppd_next; 515 } pm_ppm_devlist_t; 516 517 /* 518 * This struct is used by the code that brings up parents and notifies 519 * ppm drivers across probe/attach/detach (pm_pre/post_probe/attach/detach()) 520 */ 521 typedef struct pm_ppm_cookie { 522 dev_info_t *ppc_dip; /* dip of target node */ 523 dev_info_t *ppc_pdip; /* parent's dip */ 524 dev_info_t *ppc_ppm; /* interested ppm driver */ 525 int ppc_cmd; /* attach/detach cmd */ 526 } pm_ppm_cookie_t; 527 528 /* 529 * This struct records one dependency (a device keeps another or others up) 530 * pdr_size includes size of strings. 531 */ 532 typedef struct pm_dep_rec { 533 char *pdr_keeper; /* physpath of device keeping up */ 534 char *pdr_kept; /* physpath or property name */ 535 char **pdr_kept_paths; /* array of kept devices' paths */ 536 struct pm_dep_rec *pdr_next; /* next dependency device */ 537 size_t pdr_size; /* size to kmem_free */ 538 major_t pdr_major; /* major of kept driver (not props) */ 539 int pdr_isprop; /* true if kept is property name */ 540 int pdr_kept_count; /* how many kept altogether */ 541 int pdr_satisfied; /* true if in force (not properties) */ 542 } pm_pdr_t; 543 544 545 /* 546 * This struct records threshold information about a single component 547 */ 548 typedef struct pm_thresh_entry { 549 int pte_numthresh; 550 int *pte_thresh; 551 } pm_pte_t; 552 553 /* 554 * Note that this header and its array of entry structs with their arrays 555 * of thresholds and string storage for physpath are all kmem_alloced in one 556 * chunk for easy freeing ptr_size is the size of that chunk 557 */ 558 typedef struct pm_thresh_rec { 559 char *ptr_physpath; /* identifies node */ 560 struct pm_thresh_rec *ptr_next; 561 int ptr_numcomps; /* number of components */ 562 size_t ptr_size; /* total size for kmem_free */ 563 pm_pte_t *ptr_entries; 564 } pm_thresh_rec_t; 565 566 /* 567 * pmi_dev_pm_state state bits: 568 */ 569 570 /* 571 * a direct-pm device, not scanned, but controlled by a process 572 */ 573 #define PM_DIRECT 0x1 574 /* 575 * autopm is suspended while waiting to see if detach succeeds 576 */ 577 #define PM_DETACHING 0x2 578 579 /* 580 * An all_to_normal operation for an autopm device that is detaching, is 581 * deferred in case the detach fails. 582 */ 583 #define PM_ALLNORM_DEFERRED 0x4 584 585 #define PM_GET_PM_INFO(dip) (DEVI(dip)->devi_pm_info) 586 #define PM_GET_PM_SCAN(dip) (DEVI(dip)->devi_pm_scan) 587 588 #define PM_NUMCMPTS(dip) (DEVI(dip)->devi_pm_num_components) 589 #define PM_CP(dip, comp) (&DEVI(dip)->devi_pm_components[comp]) 590 591 /* 592 * Returns true if the device specified by dip is directly power managed 593 */ 594 #define PM_ISDIRECT(dip) \ 595 (((pm_info_t *)PM_GET_PM_INFO(dip))->pmi_dev_pm_state & PM_DIRECT) 596 597 /* 598 * Returns true if the device specified by dip is an old node for which we 599 * provide backwards compatible behavior (e.g. no pm-components property). 600 */ 601 #define PM_ISBC(dip) (DEVI(dip)->devi_pm_flags & PMC_BC) 602 603 /* 604 * Returns true if we have skipped a dependency bringup on this dip. 605 */ 606 #define PM_SKBU(dip) (DEVI(dip)->devi_pm_flags & PMC_SKIP_BRINGUP) 607 608 /* 609 * Returns true if device specified by dip is a power manageable CPU. 610 */ 611 #define PM_ISCPU(dip) (DEVI(dip)->devi_pm_flags & PMC_CPU_DEVICE) 612 613 /* 614 * Returns true if cpupm is enabled. 615 */ 616 #define PM_CPUPM_ENABLED (cpupm == PM_CPUPM_ENABLE) 617 618 /* 619 * Returns true if is disabled. 620 */ 621 #define PM_CPUPM_DISABLED (cpupm == PM_CPUPM_DISABLE) 622 623 /* 624 * If (autopm is enabled and 625 * (CPUs are not disabled, or it isn't a cpu)) OR 626 * (CPUs are enabled and it is one) 627 */ 628 #define PM_SCANABLE(dip) ((autopm_enabled && \ 629 (!PM_CPUPM_DISABLED || !PM_ISCPU(dip))) || (PM_CPUPM_ENABLED && PM_ISCPU(dip))) 630 631 #define PM_NOT_ALL_LOWEST 0x0 /* not all components are at lowest */ 632 #define PM_ALL_LOWEST 0x1 /* all components are at lowest lvl */ 633 634 #define PM_ADDR(dip) (ddi_get_name_addr(dip) ? ddi_get_name_addr(dip) : "") 635 #define PM_NAME(dip) (ddi_binding_name(dip)) 636 #define PM_NODE(dip) (ddi_node_name(dip)) 637 #define PM_INST(dip) (ddi_get_instance(dip)) 638 #define PM_DEVICE(dip) PM_NAME(dip), PM_ADDR(dip), PM_NODE(dip), PM_INST(dip) 639 640 #ifdef DEBUG 641 /* 642 * Flags passed to PMD to enable debug printfs. If the same flag is set in 643 * pm_debug below then the message is printed. The most generally useful 644 * ones are the first 3 or 4. 645 */ 646 #define PMD_ERROR 0x0000001 647 #define PMD_FAIL 0x0000002 648 #define PMD_IOCTL 0x0000004 649 #define PMD_SCAN 0x0000008 650 #define PMD_RESCAN 0x0000010 651 #define PMD_REMINFO 0x0000020 652 #define PMD_NAMETODIP 0x0000040 653 #define PMD_CLOSE 0x0000080 654 #define PMD_DIN 0x0000100 /* Dev Is Needed */ 655 #define PMD_PMC 0x0000200 /* for testing with sun4m pmc driver */ 656 #define PMD_PPM 0x0000400 657 #define PMD_DEP 0x0000800 /* dependency processing */ 658 #define PMD_IDLEDOWN 0x0001000 659 #define PMD_SET 0x0002000 660 #define PMD_BRING 0x0004000 661 #define PMD_ALLNORM 0x0008000 662 #define PMD_REMDEV 0x0010000 663 #define PMD_LEVEL 0x0020000 664 #define PMD_THRESH 0x0040000 665 #define PMD_DPM 0x0080000 /* Direct Power Management */ 666 #define PMD_NORM 0x0100000 667 #define PMD_STATS 0x0200000 668 #define PMD_DEREG 0x0400000 669 #define PMD_KEEPS 0x0800000 670 #define PMD_KIDSUP 0x1000000 671 #define PMD_TCHECK 0x2000000 672 #define PMD_NOINVOL 0x4000000 673 #define PMD_CFB 0x8000000 /* console fb pm */ 674 #define PMD_DHR 0x10000000 /* driver hold/rele changes */ 675 #define PMD_PIL 0x20000000 /* print out PIL when calling power */ 676 #define PMD_PHC 0x40000000 /* pm_power_has_changed messages */ 677 #define PMD_LOCK 0x80000000 678 #define PMD_SX 0x80000000 /* ACPI S[1234] states */ 679 #define PMD_PROTO PMD_SX /* and other Prototype stuff */ 680 681 extern uint_t pm_debug; 682 extern uint_t pm_divertdebug; 683 /*PRINTFLIKE1*/ 684 extern void pm_log(const char *fmt, ...) __KPRINTFLIKE(1); 685 686 #if !defined(__sparc) 687 /* 688 * On non-sparc machines, PMDDEBUG isn't as big a deal as Sparc, so we 689 * define PMDDEUG here for use on non-sparc platforms. 690 */ 691 #define PMDDEBUG 692 #endif /* !__sparc */ 693 694 #ifdef PMDDEBUG 695 #define PMD(level, arglist) { \ 696 if (pm_debug & (level)) { \ 697 pm_log arglist; \ 698 } \ 699 } 700 #else /* !PMDDEBUG */ 701 #define PMD(level, arglist) ((void)0); 702 #endif /* PMDDEBUG */ 703 #ifndef sparc 704 extern clock_t pt_sleep; 705 /* code is char hex number to display on POST LED */ 706 #define PT(code) {outb(0x80, (char)code); drv_usecwait(pt_sleep); } 707 #else 708 #define PT(code) 709 #endif 710 #else 711 #define PMD(level, arglist) 712 #define PT(code) 713 #endif 714 /* 715 * Code Value Indication 716 * 717 */ 718 #define PT_SPL7 0x01 /* pm_suspend spl7 */ 719 #define PT_PMSRET 0x02 /* pm_suspend returns */ 720 #define PT_PPMCTLOP 0x03 /* invoking ppm_ctlops */ 721 #define PT_ACPISDEV 0x04 /* acpi suspend devices */ 722 #define PT_IC 0x05 /* acpi intr_clear */ 723 #define PT_1to1 0x06 /* 1:1 mapping */ 724 #define PT_SC 0x07 /* save context */ 725 #define PT_SWV 0x08 /* set waking vector */ 726 #define PT_SWV_FAIL 0x09 /* set waking vector failed */ 727 #define PT_EWE 0x0a /* enable wake events */ 728 #define PT_EWE_FAIL 0x0b /* enable wake events failed */ 729 #define PT_RTCW 0x0c /* setting rtc wakeup */ 730 #define PT_RTCW_FAIL 0x0d /* setting rtc wakeup failed */ 731 #define PT_TOD 0x0e /* setting tod */ 732 #define PT_SXP 0x0f /* sx prep */ 733 #define PT_SXE 0x10 /* sx enter */ 734 #define PT_SXE_FAIL 0x11 /* sx enter failed */ 735 #define PT_INSOM 0x12 /* insomnia label */ 736 #define PT_WOKE 0x20 /* woke up */ 737 #define PT_UNDO1to1 0x21 /* Undo 1:1 mapping */ 738 #define PT_LSS 0x22 /* leave sleep state */ 739 #define PT_LSS_FAIL 0x23 /* leave sleep state failed */ 740 #define PT_DPB 0x24 /* disable power button */ 741 #define PT_DPB_FAIL 0x25 /* disable power button failed */ 742 #define PT_DRTC_FAIL 0x26 /* disable rtc fails */ 743 #define PT_ACPIREINIT 0x27 /* reinit apic */ 744 #define PT_ACPIRESTORE 0x28 /* restore apic */ 745 #define PT_INTRRESTORE 0x28 /* restore interrupts */ 746 #define PT_RESDEV 0x2a /* ressume acpi devices */ 747 #define PT_CPU 0x2b /* init_cpu_syscall */ 748 #define PT_PRESUME 0x30 /* pm_resume entered */ 749 #define PT_RSUS 0x31 /* pm_resume "suspended" */ 750 #define PT_RKERN 0x32 /* pm_resume "kernel" */ 751 #define PT_RDRV 0x33 /* pm_resume "driver" */ 752 #define PT_RDRV_FAIL 0x34 /* pm_resume "driver" failed */ 753 #define PT_RRNOINVOL 0x35 /* pm_resume "reattach_noinvol" */ 754 #define PT_RUSER 0x36 /* pm_resume "user" */ 755 #define PT_RAPMSIG 0x37 /* pm_resume APM/SRN signal */ 756 #define PT_RMPO 0x38 /* pm_resume "mp_online" */ 757 #define PT_RDONE 0x39 /* pm_resume done */ 758 759 extern void pm_detaching(dev_info_t *); 760 extern void pm_detach_failed(dev_info_t *); 761 extern int pm_power(dev_info_t *, int, int); 762 extern int pm_unmanage(dev_info_t *); 763 extern void pm_rem_info(dev_info_t *); 764 extern int pm_get_norm_pwrs(dev_info_t *, int **, size_t *); 765 extern dev_info_t *pm_name_to_dip(char *, int); 766 extern int pm_power_up(dev_info_t *, int, int, int, pm_info_t *); 767 extern int pm_default_idle_threshold; 768 extern void pm_set_device_threshold(dev_info_t *, int, int); 769 extern int pm_valid_power(dev_info_t *, int, int); 770 extern void pm_lock_power(dev_info_t *, int *); 771 extern void pm_unlock_power(dev_info_t *, int); 772 extern int pm_try_locking_power(dev_info_t *, int *); 773 extern void pm_lock_power_single(dev_info_t *, int *); 774 extern void pm_unlock_power_single(dev_info_t *, int); 775 extern int pm_try_locking_power_single(dev_info_t *, int *); 776 extern int pm_isbc(dev_info_t *dip); 777 extern int pm_isdirect(dev_info_t *dip); 778 extern int pm_ctlops(dev_info_t *d, dev_info_t *r, ddi_ctl_enum_t o, 779 void *a, void *v); 780 extern int pm_noinvol_detached(char *); 781 extern int pm_init_child(dev_info_t *); 782 extern int pm_uninit_child(dev_info_t *); 783 784 extern int pm_all_to_normal(dev_info_t *, pm_canblock_t); 785 extern int pm_set_power(dev_info_t *, int, int, int, pm_canblock_t, int, 786 int *); 787 extern void pm_scan_init(dev_info_t *dip); 788 extern void pm_scan_fini(dev_info_t *dip); 789 extern void pm_scan_stop(dev_info_t *dip); 790 extern int pm_scan_stop_walk(dev_info_t *dip, void *); 791 extern void pm_scan(void *); 792 extern time_t pm_scan_dev(dev_info_t *dip); 793 extern void pm_rescan(void *); 794 extern int pm_rescan_walk(dev_info_t *, void *); 795 extern void pm_forget_power_level(dev_info_t *); 796 extern int pm_pre_config(dev_info_t *, char *); 797 extern int pm_pre_unconfig(dev_info_t *, int, int *, char *); 798 extern void pm_post_config(dev_info_t *, char *); 799 extern void pm_post_unconfig(dev_info_t *, int, char *); 800 extern void pm_pre_probe(dev_info_t *, pm_ppm_cookie_t *); 801 extern void pm_post_probe(pm_ppm_cookie_t *, int, int); 802 extern void pm_post_attach(pm_ppm_cookie_t *, int); 803 extern void pm_pre_attach(dev_info_t *, pm_ppm_cookie_t *, 804 ddi_attach_cmd_t); 805 extern void pm_pre_detach(dev_info_t *, ddi_detach_cmd_t, 806 pm_ppm_cookie_t *); 807 extern void pm_post_detach(pm_ppm_cookie_t *, int); 808 extern int pm_powerup(dev_info_t *); 809 extern int pm_all_at_normal(dev_info_t *); 810 extern int pm_busop_bus_power(dev_info_t *, void *, 811 pm_bus_power_op_t, void *, void *); 812 extern void pm_hold_power(dev_info_t *); 813 extern void pm_rele_power(dev_info_t *); 814 extern void pm_driver_removed(major_t); 815 extern void pm_borrow_lock(kthread_t *); 816 extern void pm_return_lock(void); 817 extern int pm_reattach_noinvol(void); 818 extern void pm_reattach_noinvol_fini(); 819 extern void pm_restore_direct_levels(void); 820 extern void pm_save_direct_levels(void); 821 extern void pm_cfb_setup(const char *); 822 extern void pm_proceed(dev_info_t *, int, int, int); 823 extern void pm_get_timestamps(dev_info_t *, time_t *); 824 extern void pm_deregister_watcher(int, dev_info_t *); 825 extern void pm_dispatch_to_dep_thread(int, char *, char *, int, int *, int); 826 extern int e_pm_valid_comp(dev_info_t *, int, pm_component_t **); 827 extern int e_pm_valid_info(dev_info_t *, pm_info_t **); 828 extern int e_pm_valid_power(dev_info_t *, int, int); 829 extern void pm_init_locks(void); 830 extern int pm_register_ppm(int (*)(dev_info_t *), dev_info_t *); 831 extern int pm_is_cfb(dev_info_t *); 832 #ifdef DEBUG 833 extern int pm_cfb_is_up(void); 834 #endif 835 836 #ifdef DIPLOCKDEBUG 837 #define PM_LOCK_DIP(dip) { PMD(PMD_LOCK, ("dip lock %s@%s(%s#%d) " \ 838 "%s %d\n", PM_DEVICE(dip), \ 839 __FILE__, __LINE__)) \ 840 mutex_enter(&DEVI(dip)->devi_pm_lock); } 841 #define PM_UNLOCK_DIP(dip) { PMD(PMD_LOCK, ("dip unlock %s@%s(%s#%d) " \ 842 "%s %d\n", PM_DEVICE(dip), \ 843 __FILE__, __LINE__)) \ 844 mutex_exit(&DEVI(dip)->devi_pm_lock); } 845 #else 846 #define PM_LOCK_DIP(dip) mutex_enter(&DEVI(dip)->devi_pm_lock) 847 #define PM_UNLOCK_DIP(dip) mutex_exit(&DEVI(dip)->devi_pm_lock) 848 #endif 849 850 /* 851 * These are the same DEBUG or not 852 */ 853 #define PM_LOCK_BUSY(dip) mutex_enter(&DEVI(dip)->devi_pm_busy_lock) 854 #define PM_UNLOCK_BUSY(dip) mutex_exit(&DEVI(dip)->devi_pm_busy_lock) 855 #define PM_LOCK_POWER(dip, circp) pm_lock_power(dip, circp) 856 #define PM_UNLOCK_POWER(dip, circ) pm_unlock_power(dip, circ) 857 #define PM_TRY_LOCK_POWER(dip, circp) pm_try_locking_power(dip, circp) 858 #define PM_IAM_LOCKING_DIP(dip) (mutex_owned(&DEVI(dip)->devi_pm_lock)) 859 860 #define PM_DEFAULT_SYS_IDLENESS 1800 /* 30 minutes */ 861 862 /* 863 * Codes put into the pr_retval field of pm_rsvp_t that tell pm_block() 864 * how to proceed 865 */ 866 #define PMP_SUCCEED 0x1 /* return success, the process did it */ 867 #define PMP_FAIL 0x2 /* return fail, process did something else */ 868 #define PMP_RELEASE 0x3 /* let it go, the process has lost interest */ 869 /* also arg to pm_proceed to signal this */ 870 /* 871 * Values of "style" for e_pm_manage and pm_premanage 872 */ 873 #define PM_STYLE_NEW 0 874 #define PM_STYLE_UNKNOWN 1 875 876 /* 877 * Arg passed to pm_proceed that results in PMP_SUCCEED or PMP_FAIL being set 878 * in pr_retval depending on what is pending 879 */ 880 #define PMP_SETPOWER 0x4 881 882 #define PM_MAX_CLONE 256 883 884 typedef struct pm_rsvp { 885 dev_info_t *pr_dip; 886 int pr_comp; 887 int pr_newlevel; 888 int pr_oldlevel; 889 kcondvar_t pr_cv; /* a place to sleep */ 890 int pr_retval; /* what to do when you wake up */ 891 struct pm_rsvp *pr_next; 892 struct pm_rsvp *pr_prev; 893 } pm_rsvp_t; 894 895 typedef struct psce { /* pm_state_change_entries */ 896 struct pm_state_change *psce_first; 897 struct pm_state_change *psce_in; 898 struct pm_state_change *psce_out; 899 struct pm_state_change *psce_last; 900 int psce_overruns; 901 int psce_references; 902 kmutex_t psce_lock; 903 } psce_t; 904 905 typedef struct pscc { /* pm_state_change_control */ 906 int pscc_clone; 907 dev_info_t *pscc_dip; 908 psce_t *pscc_entries; 909 struct pscc *pscc_next; 910 struct pscc *pscc_prev; 911 } pscc_t; 912 913 #define PSCCOUNT 128 /* number of state change entries kept per process */ 914 915 /* 916 * Struct used to track the existence of devices exporting the 917 * no-involuntary-power-cycles property, and remember things from their 918 * devinfo node for later attach. 919 */ 920 typedef struct pm_noinvol { 921 struct pm_noinvol *ni_next; 922 char *ni_path; 923 major_t ni_major; /* for attaching at cpr time */ 924 uint_t ni_flags; /* selected PMC_* values */ 925 uint_t ni_noinvolpm; /* saved noinvolpm count */ 926 uint_t ni_volpmd; /* saved volpmd count */ 927 uint_t ni_wasvolpmd; /* was vol pm'd at detach */ 928 size_t ni_size; 929 int ni_persistent; /* still around */ 930 } pm_noinvol_t; 931 932 #define PMID_IOCTIMER 0x1 /* pm_ioctl sets during timer */ 933 #define PMID_CFBTIMER 0x2 /* cfb sets during timer */ 934 #define PMID_IOCSCAN 0x4 /* pm_ioctl sets during scan */ 935 #define PMID_CFBSCAN 0x8 /* cfb sets during scan */ 936 937 #define PMID_IOC (PMID_IOCTIMER | PMID_IOCSCAN) 938 #define PMID_CFB (PMID_CFBTIMER | PMID_CFBSCAN) 939 #define PMID_TIMERS (PMID_IOCTIMER | PMID_CFBTIMER) 940 #define PMID_SCANS (PMID_IOCSCAN | PMID_CFBSCAN) 941 #define PMID_SCANS_SHIFT 2 942 #define PMID_SET_SCANS(pmid) (pmid) |= (((pmid) & PMID_TIMERS) << \ 943 PMID_SCANS_SHIFT); 944 #define PMID_IS_IOC(pmid) ((pmid) & PMID_IOC) 945 #define PMID_IS_CFB(pmid, dip) (((pmid) & PMID_CFB) && \ 946 (DEVI(dip)->devi_pm_flags & \ 947 (PMC_DEF_THRESH | PMC_NEXDEF_THRESH))) 948 #define PM_IS_PID(dip) (PMID_IS_IOC(PM_GET_PM_SCAN(dip)->ps_idle_down) || \ 949 PMID_IS_CFB(PM_GET_PM_SCAN(dip)->ps_idle_down, dip)) 950 #define PM_IS_CFB(dip) (DEVI(dip)->devi_pm_flags & PMC_CONSOLE_FB) 951 #define PM_KUC(dip) (DEVI(dip)->devi_pm_kidsupcnt) 952 #define PM_CURPOWER(dip, comp) cur_power(PM_CP(dip, comp)) 953 954 #define PM_WANTS_NOTIFICATION(dip) \ 955 (DEVI(dip)->devi_pm_flags & PMC_WANTS_NOTIFY) 956 957 #define PM_HAS_BUS_POWER(dip) \ 958 ((DEVI(dip)->devi_ops->devo_bus_ops != NULL) && \ 959 (DEVI(dip)->devi_ops->devo_bus_ops->busops_rev >= BUSO_REV_7) &&\ 960 (DEVI(dip)->devi_ops->devo_bus_ops->bus_power != NULL)) 961 962 #define PM_BUS_POWER_FUNC(dip) \ 963 DEVI(dip)->devi_ops->devo_bus_ops->bus_power 964 965 /* 966 * Structure used to pass down sunpm's private data variables 967 * through the bus_power bus_op calls 968 */ 969 typedef struct pm_sp_misc { 970 pm_canblock_t pspm_canblock; 971 int pspm_scan; 972 int *pspm_errnop; 973 int pspm_direction; 974 } pm_sp_misc_t; 975 976 /* 977 * This structure is used in validating that the power level 978 * of the descendents are off, while a device is powered off. 979 */ 980 typedef struct pm_desc_pwrchk { 981 dev_info_t *pdpc_dip; 982 int pdpc_par_involved; 983 } pm_desc_pwrchk_t; 984 985 986 /* 987 * These defines are used by pm_trans_check() to calculate time. 988 * Mostly copied from "tzfile.h". 989 */ 990 #define DC_SPY (SECSPERDAY * DAYSPERNYEAR) 991 #define DC_SPW (SECSPERDAY * DAYSPERWEEK) 992 #define DC_SPD SECSPERDAY 993 994 #define DC_SCSI_YEAR_LEN 4 /* YYYY */ 995 #define DC_SCSI_WEEK_LEN 2 /* WW */ 996 #define DC_SCSI_NPY 5 /* # power-cycle years */ 997 998 #endif /* _KERNEL */ 999 1000 #ifdef __cplusplus 1001 } 1002 #endif 1003 1004 #endif /* _SYS_EPM_H */ 1005