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