^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) /* SPDX-License-Identifier: GPL-2.0-or-later */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) * pnpbios.h - contains local definitions
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) * Include file for the interface to a PnP BIOS
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) * Original BIOS code (C) 1998 Christian Schmidt (chr.schmidt@tu-bs.de)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) * PnP handler parts (c) 1998 Tom Lees <tom@lpsg.demon.co.uk>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) * Minor reorganizations by David Hinds <dahinds@users.sourceforge.net>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) * Return codes
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) #define PNP_SUCCESS 0x00
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) #define PNP_NOT_SET_STATICALLY 0x7f
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) #define PNP_UNKNOWN_FUNCTION 0x81
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) #define PNP_FUNCTION_NOT_SUPPORTED 0x82
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) #define PNP_INVALID_HANDLE 0x83
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) #define PNP_BAD_PARAMETER 0x84
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) #define PNP_SET_FAILED 0x85
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) #define PNP_EVENTS_NOT_PENDING 0x86
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) #define PNP_SYSTEM_NOT_DOCKED 0x87
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) #define PNP_NO_ISA_PNP_CARDS 0x88
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) #define PNP_UNABLE_TO_DETERMINE_DOCK_CAPABILITIES 0x89
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) #define PNP_CONFIG_CHANGE_FAILED_NO_BATTERY 0x8a
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) #define PNP_CONFIG_CHANGE_FAILED_RESOURCE_CONFLICT 0x8b
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) #define PNP_BUFFER_TOO_SMALL 0x8c
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) #define PNP_USE_ESCD_SUPPORT 0x8d
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) #define PNP_MESSAGE_NOT_SUPPORTED 0x8e
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) #define PNP_HARDWARE_ERROR 0x8f
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) #define ESCD_SUCCESS 0x00
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) #define ESCD_IO_ERROR_READING 0x55
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) #define ESCD_INVALID 0x56
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) #define ESCD_BUFFER_TOO_SMALL 0x59
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) #define ESCD_NVRAM_TOO_SMALL 0x5a
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) #define ESCD_FUNCTION_NOT_SUPPORTED 0x81
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) * Events that can be received by "get event"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) #define PNPEV_ABOUT_TO_CHANGE_CONFIG 0x0001
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) #define PNPEV_DOCK_CHANGED 0x0002
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) #define PNPEV_SYSTEM_DEVICE_CHANGED 0x0003
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) #define PNPEV_CONFIG_CHANGED_FAILED 0x0004
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) #define PNPEV_UNKNOWN_SYSTEM_EVENT 0xffff
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) /* 0x8000 through 0xfffe are OEM defined */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) * Messages that should be sent through "send message"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) #define PNPMSG_OK 0x00
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) #define PNPMSG_ABORT 0x01
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) #define PNPMSG_UNDOCK_DEFAULT_ACTION 0x40
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) #define PNPMSG_POWER_OFF 0x41
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) #define PNPMSG_PNP_OS_ACTIVE 0x42
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) #define PNPMSG_PNP_OS_INACTIVE 0x43
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) * Plug and Play BIOS flags
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) #define PNPBIOS_NO_DISABLE 0x0001
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) #define PNPBIOS_NO_CONFIG 0x0002
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) #define PNPBIOS_OUTPUT 0x0004
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) #define PNPBIOS_INPUT 0x0008
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) #define PNPBIOS_BOOTABLE 0x0010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) #define PNPBIOS_DOCK 0x0020
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) #define PNPBIOS_REMOVABLE 0x0040
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) #define pnpbios_is_static(x) (((x)->flags & 0x0100) == 0x0000)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) #define pnpbios_is_dynamic(x) ((x)->flags & 0x0080)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) * Function Parameters
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) #define PNPMODE_STATIC 1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) #define PNPMODE_DYNAMIC 0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) /* 0x8000 through 0xffff are OEM defined */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) #pragma pack(1)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) struct pnp_dev_node_info {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) __u16 no_nodes;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) __u16 max_node_size;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) struct pnp_docking_station_info {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) __u32 location_id;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) __u32 serial;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) __u16 capabilities;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) struct pnp_isa_config_struc {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) __u8 revision;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) __u8 no_csns;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) __u16 isa_rd_data_port;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) __u16 reserved;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) struct escd_info_struc {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) __u16 min_escd_write_size;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) __u16 escd_size;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) __u32 nv_storage_base;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) struct pnp_bios_node {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) __u16 size;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) __u8 handle;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) __u32 eisa_id;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) __u8 type_code[3];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) __u16 flags;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) __u8 data[];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) #pragma pack()
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) /* non-exported */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) extern struct pnp_dev_node_info node_info;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) extern int pnp_bios_dev_node_info(struct pnp_dev_node_info *data);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) extern int pnp_bios_get_dev_node(u8 *nodenum, char config,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) struct pnp_bios_node *data);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) extern int pnp_bios_set_dev_node(u8 nodenum, char config,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) struct pnp_bios_node *data);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) extern int pnp_bios_get_stat_res(char *info);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) extern int pnp_bios_isapnp_config(struct pnp_isa_config_struc *data);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) extern int pnp_bios_escd_info(struct escd_info_struc *data);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) extern int pnp_bios_read_escd(char *data, u32 nvram_base);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) extern int pnp_bios_dock_station_info(struct pnp_docking_station_info *data);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) #pragma pack(1)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) union pnp_bios_install_struct {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) struct {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) u32 signature; /* "$PnP" */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) u8 version; /* in BCD */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) u8 length; /* length in bytes, currently 21h */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) u16 control; /* system capabilities */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) u8 checksum; /* all bytes must add up to 0 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) u32 eventflag; /* phys. address of the event flag */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138) u16 rmoffset; /* real mode entry point */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) u16 rmcseg;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) u16 pm16offset; /* 16 bit protected mode entry */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) u32 pm16cseg;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) u32 deviceID; /* EISA encoded system ID or 0 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) u16 rmdseg; /* real mode data segment */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) u32 pm16dseg; /* 16 bit pm data segment base */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) } fields;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) char chars[0x21]; /* To calculate the checksum */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) #pragma pack()
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150) extern int pnp_bios_present(void);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151) extern int pnpbios_dont_use_current_config;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) extern int pnpbios_parse_data_stream(struct pnp_dev *dev, struct pnp_bios_node * node);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) extern int pnpbios_read_resources_from_node(struct pnp_dev *dev, struct pnp_bios_node *node);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) extern int pnpbios_write_resources_to_node(struct pnp_dev *dev, struct pnp_bios_node *node);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) extern void pnpid32_to_pnpid(u32 id, char *str);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) extern void pnpbios_print_status(const char * module, u16 status);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) extern void pnpbios_calls_init(union pnp_bios_install_struct * header);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) #ifdef CONFIG_PNPBIOS_PROC_FS
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162) extern int pnpbios_interface_attach_device(struct pnp_bios_node * node);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163) extern int pnpbios_proc_init (void);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164) extern void pnpbios_proc_exit (void);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165) #else
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166) static inline int pnpbios_interface_attach_device(struct pnp_bios_node * node) { return 0; }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167) static inline int pnpbios_proc_init (void) { return 0; }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168) static inline void pnpbios_proc_exit (void) { ; }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169) #endif /* CONFIG_PNPBIOS_PROC_FS */