1 /* $NetBSD: pnpbiosreg.h,v 1.4 2007/12/25 18:33:33 perry Exp $ */ 2 /* 3 * Copyright (c) 2000 Christian E. Hopps 4 * All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 3. The name of the author may not be used to endorse or promote products 15 * derived from this software without specific prior written permission 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27 */ 28 /* functions */ 29 #define PNP_FC_GET_NUM_NODES 0x00 30 #define PNP_FC_GET_DEVICE_NODE 0x01 31 #define PNP_FC_SET_DEVICE_NODE 0x02 32 #define PNP_FC_GET_EVENT 0x03 33 #define PNP_FC_SEND_MESSAGE 0x04 34 #define PNP_FC_GET_DOCK_INFO 0x05 35 #define PNP_FC_SET_STATIC_RES 0x09 /* no support currently */ 36 #define PNP_FC_GET_STATIC_RES 0x0A /* no support currently */ 37 #define PNP_FC_GET_APM_TABLE 0x0B 38 #define PNP_FC_GET_ISA_CONFIG 0x40 /* no support currently */ 39 #define PNP_FC_GET_ESCD_SYS_CONFIG 0x41 /* no support currently */ 40 #define PNP_FC_READ_ESCD_SYS_CONFIG 0x42 /* no support currently */ 41 #define PNP_FC_WRITE_ESCD_SYS_CONFIG 0x43 /* no support currently */ 42 43 /* return codes from pnp bios calls */ 44 #define PNP_RC_SUCCESS 0x00 45 #define PNP_RC_ERROR_MASK 0x80 46 #define PNP_RC_RESERVED 0x01 47 #define PNP_RC_NOT_SET_STATICALLY 0x7f /* warning */ 48 #define PNP_RC_UNKNOWN_FUNCTION 0x81 49 #define PNP_RC_FUNCTION_NOT_SUPPORTED 0x82 50 #define PNP_RC_INVALID_HANDLE 0x83 51 #define PNP_RC_BAD_PARAMETER 0x84 52 #define PNP_RC_SET_FAILED 0x85 53 #define PNP_RC_EVENTS_NOT_PENDING 0x86 54 #define PNP_RC_SYSTEM_NOT_DOCKED 0x87 55 #define PNP_RC_NO_ISA_PNP_CARDS 0x88 56 #define PNP_RC_UNABLE_TO_DETERMINE_DOCK_CAPABILITIES 0x89 57 #define PNP_RC_CONFIG_CHANGE_FAILED_NO_BATTERY 0x8a 58 #define PNP_RC_CONFIG_CHANGE_FAILED_RESOURCE_CONFLICT 0x8b 59 #define PNP_RC_BUFFER_TOO_SMALL 0x8c 60 #define PNP_RC_USE_ESCD_SUPPORT 0x8d 61 #define PNP_RC_MESSAGE_NOT_SUPPORTED 0x8e 62 #define PNP_RC_HARDWARE_ERROR 0x8f 63 64 /* event identifiers */ 65 #define PNP_EID_ABOUT_TO_CHANGE_CONFIG 0x0001 66 #define PNP_EID_DOCK_CHANGED 0x0002 67 #define PNP_EID_SYSTEM_DEVICE_CHANGED 0x0003 68 #define PNP_EID_CONFIG_CHANGE_FAILED 0x0004 69 #define PNP_EID_UNKNOWN_SYSTEM_EVENT 0xffff 70 #define PNP_EID_OEM_DEFINED_BIT 0x8000 71 72 /* response messages */ 73 #define PNP_RM_OK 0x00 74 #define PNP_RM_ABORT 0x01 75 76 /* control messages */ 77 #define PNP_CM_UNDOCK_DEFAULT_ACTION 0x0040 78 #define PNP_CM_POWER_OFF 0x0041 79 #define PNP_CM_PNP_OS_ACTIVE 0x0042 80 #define PNP_CM_PNP_OS_INACTIVE 0x0043 81 #define PNP_CM_OEM_DEFINED_BIT 0x8000 82 83 /* control flags -- used with [GS]ET_DEVICE_NODE */ 84 #define PNP_CF_DEVCONF_DYNAMIC 0x01 85 #define PNP_CF_DEVCONF_STATIC 0x02 86 87 /* main pnpbios structure -- note not naturally aligned */ 88 struct pnpinstcheck { 89 uint32_t ic_sig; /* '$PnP' */ 90 uint8_t ic_version; /* 0x10 currently */ 91 uint8_t ic_length; /* 0x21 currently */ 92 uint16_t ic_control; 93 uint8_t ic_cksum; 94 uint32_t ic_evaddr; 95 uint16_t ic_rcodeoff; 96 uint16_t ic_rcodeseg; 97 uint16_t ic_pcodeoff; 98 uint32_t ic_pcodeseg; 99 uint32_t ic_oemid; 100 uint16_t ic_rdataseg; 101 uint32_t ic_pdataseg; 102 } __packed; 103 #define PNP_IC_VERSION_1_0 0x10 104 #define PNP_IC_CONTORL_EVENT_MASK 0x0003 105 #define PNP_IC_CONTROL_EVENT_NONE 0x0000 106 #define PNP_IC_CONTROL_EVENT_POLL 0x0001 107 #define PNP_IC_CONTROL_EVENT_ASYNC 0x0002 108 109 /* structure used by [GS]ET_DEVICE_NODE -- note not naturally aligned */ 110 struct pnpdevnode { 111 uint16_t dn_size; 112 uint8_t dn_handle; 113 uint32_t dn_product; 114 uint8_t dn_type; /* base type */ 115 uint8_t dn_subtype; /* sub type depends on base */ 116 uint8_t dn_dpi; /* dev prog intf depends on subtype */ 117 uint16_t dn_attr; 118 /* variable - allocated resource */ 119 /* variable - possible resource */ 120 /* variable - compatible identifiers */ 121 } __packed; 122 #define PNP_DN_ATTR_CONFIG_TIME_MASK 0x0180 123 #define PNP_DN_ATTR_CONFIG_TIME_NEXT_BOOT 0x0000 124 #define PNP_DN_ATTR_CONFIG_TIME_BOTH 0x0080 125 #define PNP_DN_ATTR_CONFIG_TIME_RUNTIME 0x0180 126 #define PNP_DN_ATTR_REMOVABLE 0x0040 127 #define PNP_DN_ATTR_DOCK_DEVICE 0x0010 128 #define PNP_DN_ATTR_CAP_PRIMARY_IPL 0x0010 129 #define PNP_DN_ATTR_CAP_PRIMARY_INPUT 0x0008 130 #define PNP_DN_ATTR_CAP_PRIMARY_OUTPUT 0x0004 131 #define PNP_DN_ATTR_CAN_CONFIGURE 0x0002 132 #define PNP_DN_ATTR_CAN_DISABLE 0x0001 133 134 135 /* returned by GET_DOCK_INFO bios call */ 136 struct pnpdockinfo { 137 uint32_t di_id; /* dock station id */ 138 uint32_t di_serial; /* serial number */ 139 uint16_t di_cap; /* capabilities */ 140 } __packed; 141 #define PNP_DI_ID_UNKNOWN_DOCKING_ID 0xffffffff 142 #define PNP_DI_DOCK_WHEN_MASK 0x0006 143 #define PNP_DI_DOCK_WHEN_NO_POWER 0x0000 144 #define PNP_DI_DOCK_WHEN_SUSPENDED 0x0002 145 #define PNP_DI_DOCK_WHEN_RUNNING 0x0004 146 #define PNP_DI_DOCK_WHEN_RESERVED 0x0006 147 #define PNP_DI_DOCK_STYLE_MASK 0x0001 148 #define PNP_DI_DOCK_STYLE_SUPRISE 0x0000 /* just remove */ 149 #define PNP_DI_DOCK_STYLE_VCR 0x0001 /* controlled */ 150 151 struct pnplargeres { 152 uint8_t r_type; 153 uint16_t r_len; 154 /* variable */ 155 } __packed; 156 157 /* resource descriptors */ 158 struct pnpmem16rangeres { 159 struct pnplargeres r_hdr; 160 uint8_t r_flags; 161 uint16_t r_minbase; /* bits 23-8 */ 162 uint16_t r_maxbase; /* bits 23-8 */ 163 uint16_t r_align; /* 0 == 0x10000 */ 164 uint16_t r_len; /* bits 23-8 */ 165 } __packed; 166 167 struct pnpmem32rangeres { 168 struct pnplargeres r_hdr; 169 uint8_t r_flags; 170 uint32_t r_minbase; 171 uint32_t r_maxbase; 172 uint32_t r_align; 173 uint32_t r_len; 174 } __packed; 175 176 struct pnpfixedmem32rangeres { 177 struct pnplargeres r_hdr; 178 uint8_t r_flags; 179 uint32_t r_base; 180 uint32_t r_len; 181 } __packed; 182 183 struct pnpansiidentres { 184 struct pnplargeres r_hdr; 185 uint8_t r_id[1]; /* variable */ 186 } __packed; 187 188 struct pnpdevidres { 189 uint8_t r_hdr; 190 uint32_t r_id; 191 uint16_t r_flags; 192 } __packed; 193 194 struct pnpcompatres { 195 uint8_t r_hdr; 196 uint32_t r_id; 197 } __packed; 198 199 struct pnpirqres { 200 uint8_t r_hdr; 201 uint16_t r_mask; 202 uint8_t r_info; /* may not be present */ 203 } __packed; 204 205 struct pnpdmares { 206 uint8_t r_hdr; 207 uint8_t r_mask; 208 uint8_t r_flags; 209 } __packed; 210 211 struct pnpportres { 212 uint8_t r_hdr; 213 uint8_t r_flags; 214 uint16_t r_minbase; 215 uint16_t r_maxbase; 216 uint8_t r_align; 217 uint8_t r_len; 218 } __packed; 219 220 struct pnpfixedportres { 221 uint8_t r_hdr; 222 uint16_t r_base; 223 uint8_t r_len; 224 } __packed; 225 226 struct pnpdepstartres { 227 uint8_t r_hdr; 228 uint8_t r_pri; /* may not be present */ 229 } __packed; 230 231 struct pnpendres { 232 uint8_t r_hdr; 233 uint8_t r_cksum; 234 } __packed; 235