Logo Search packages:      
Sourcecode: pcmciautils version File versions  Download package

cistpl.h

/*
 * cistpl.h
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * The initial developer of the original code is David A. Hinds
 * <dahinds@users.sourceforge.net>.  Portions created by David A. Hinds
 * are Copyright (C) 1999 David A. Hinds.  All Rights Reserved.
 *
 * (C) 1999             David A. Hinds
 */

#ifndef _LINUX_CISTPL_H
#define _LINUX_CISTPL_H

#define CISTPL_NULL           0x00
#define CISTPL_DEVICE         0x01
#define CISTPL_LONGLINK_CB    0x02
#define CISTPL_INDIRECT       0x03
#define CISTPL_CONFIG_CB      0x04
#define CISTPL_CFTABLE_ENTRY_CB     0x05
#define CISTPL_LONGLINK_MFC   0x06
#define CISTPL_BAR            0x07
#define CISTPL_PWR_MGMNT      0x08
#define CISTPL_EXTDEVICE      0x09
#define CISTPL_CHECKSUM       0x10
#define CISTPL_LONGLINK_A     0x11
#define CISTPL_LONGLINK_C     0x12
#define CISTPL_LINKTARGET     0x13
#define CISTPL_NO_LINK        0x14
#define CISTPL_VERS_1         0x15
#define CISTPL_ALTSTR         0x16
#define CISTPL_DEVICE_A       0x17
#define CISTPL_JEDEC_C        0x18
#define CISTPL_JEDEC_A        0x19
#define CISTPL_CONFIG         0x1a
#define CISTPL_CFTABLE_ENTRY  0x1b
#define CISTPL_DEVICE_OC      0x1c
#define CISTPL_DEVICE_OA      0x1d
#define CISTPL_DEVICE_GEO     0x1e
#define CISTPL_DEVICE_GEO_A   0x1f
#define CISTPL_MANFID         0x20
#define CISTPL_FUNCID         0x21
#define CISTPL_FUNCE          0x22
#define CISTPL_SWIL           0x23
#define CISTPL_END            0xff
/* Layer 2 tuples */
#define CISTPL_VERS_2         0x40
#define CISTPL_FORMAT         0x41
#define CISTPL_GEOMETRY       0x42
#define CISTPL_BYTEORDER      0x43
#define CISTPL_DATE           0x44
#define CISTPL_BATTERY        0x45
#define CISTPL_FORMAT_A       0x47
/* Layer 3 tuples */
#define CISTPL_ORG            0x46
#define CISTPL_SPCL           0x90

00061 typedef struct cistpl_longlink_t {
      unsigned int      addr;
} cistpl_longlink_t;

00065 typedef struct cistpl_checksum_t {
      unsigned short    addr;
      unsigned short    len;
      unsigned char     sum;
} cistpl_checksum_t;

#define CISTPL_MAX_FUNCTIONS  8
#define CISTPL_MFC_ATTR       0x00
#define CISTPL_MFC_COMMON     0x01

00075 typedef struct cistpl_longlink_mfc_t {
      unsigned char     nfn;
      struct {
            unsigned char     space;
            unsigned int      addr;
      } fn[CISTPL_MAX_FUNCTIONS];
} cistpl_longlink_mfc_t;

#define CISTPL_MAX_ALTSTR_STRINGS   4

00085 typedef struct cistpl_altstr_t {
      unsigned char     ns;
      unsigned char     ofs[CISTPL_MAX_ALTSTR_STRINGS];
      char  str[254];
} cistpl_altstr_t;

#define CISTPL_DTYPE_NULL     0x00
#define CISTPL_DTYPE_ROM      0x01
#define CISTPL_DTYPE_OTPROM   0x02
#define CISTPL_DTYPE_EPROM    0x03
#define CISTPL_DTYPE_EEPROM   0x04
#define CISTPL_DTYPE_FLASH    0x05
#define CISTPL_DTYPE_SRAM     0x06
#define CISTPL_DTYPE_DRAM     0x07
#define CISTPL_DTYPE_FUNCSPEC 0x0d
#define CISTPL_DTYPE_EXTEND   0x0e

#define CISTPL_MAX_DEVICES    4

00104 typedef struct cistpl_device_t {
      unsigned char     ndev;
      struct {
            unsigned char     type;
            unsigned char     wp;
            unsigned int      speed;
            unsigned int      size;
      } dev[CISTPL_MAX_DEVICES];
} cistpl_device_t;

#define CISTPL_DEVICE_MWAIT   0x01
#define CISTPL_DEVICE_3VCC    0x02

00117 typedef struct cistpl_device_o_t {
      unsigned char           flags;
      cistpl_device_t   device;
} cistpl_device_o_t;

#define CISTPL_VERS_1_MAX_PROD_STRINGS    4

00124 typedef struct cistpl_vers_1_t {
      unsigned char     major;
      unsigned char     minor;
      unsigned char     ns;
      unsigned char     ofs[CISTPL_VERS_1_MAX_PROD_STRINGS];
      char  str[254];
} cistpl_vers_1_t;

00132 typedef struct cistpl_jedec_t {
      unsigned char     nid;
      struct {
            unsigned char     mfr;
            unsigned char     info;
      } id[CISTPL_MAX_DEVICES];
} cistpl_jedec_t;

00140 typedef struct cistpl_manfid_t {
      unsigned short    manf;
      unsigned short    card;
} cistpl_manfid_t;

#define CISTPL_FUNCID_MULTI   0x00
#define CISTPL_FUNCID_MEMORY  0x01
#define CISTPL_FUNCID_SERIAL  0x02
#define CISTPL_FUNCID_PARALLEL      0x03
#define CISTPL_FUNCID_FIXED   0x04
#define CISTPL_FUNCID_VIDEO   0x05
#define CISTPL_FUNCID_NETWORK 0x06
#define CISTPL_FUNCID_AIMS    0x07
#define CISTPL_FUNCID_SCSI    0x08

#define CISTPL_SYSINIT_POST   0x01
#define CISTPL_SYSINIT_ROM    0x02

00158 typedef struct cistpl_funcid_t {
      unsigned char     func;
      unsigned char     sysinit;
} cistpl_funcid_t;

00163 typedef struct cistpl_funce_t {
      unsigned char     type;
      unsigned char     data[0];
} cistpl_funce_t;

/*======================================================================

    Modem Function Extension Tuples

======================================================================*/

#define CISTPL_FUNCE_SERIAL_IF            0x00
#define CISTPL_FUNCE_SERIAL_CAP           0x01
#define CISTPL_FUNCE_SERIAL_SERV_DATA     0x02
#define CISTPL_FUNCE_SERIAL_SERV_FAX      0x03
#define CISTPL_FUNCE_SERIAL_SERV_VOICE    0x04
#define CISTPL_FUNCE_SERIAL_CAP_DATA      0x05
#define CISTPL_FUNCE_SERIAL_CAP_FAX 0x06
#define CISTPL_FUNCE_SERIAL_CAP_VOICE     0x07
#define CISTPL_FUNCE_SERIAL_IF_DATA 0x08
#define CISTPL_FUNCE_SERIAL_IF_FAX  0x09
#define CISTPL_FUNCE_SERIAL_IF_VOICE      0x0a

/* UART identification */
#define CISTPL_SERIAL_UART_8250           0x00
#define CISTPL_SERIAL_UART_16450    0x01
#define CISTPL_SERIAL_UART_16550    0x02
#define CISTPL_SERIAL_UART_8251           0x03
#define CISTPL_SERIAL_UART_8530           0x04
#define CISTPL_SERIAL_UART_85230    0x05

/* UART capabilities */
#define CISTPL_SERIAL_UART_SPACE    0x01
#define CISTPL_SERIAL_UART_MARK           0x02
#define CISTPL_SERIAL_UART_ODD            0x04
#define CISTPL_SERIAL_UART_EVEN           0x08
#define CISTPL_SERIAL_UART_5BIT           0x01
#define CISTPL_SERIAL_UART_6BIT           0x02
#define CISTPL_SERIAL_UART_7BIT           0x04
#define CISTPL_SERIAL_UART_8BIT           0x08
#define CISTPL_SERIAL_UART_1STOP    0x10
#define CISTPL_SERIAL_UART_MSTOP    0x20
#define CISTPL_SERIAL_UART_2STOP    0x40

00207 typedef struct cistpl_serial_t {
      unsigned char     uart_type;
      unsigned char     uart_cap_0;
      unsigned char     uart_cap_1;
} cistpl_serial_t;

00213 typedef struct cistpl_modem_cap_t {
      unsigned char     flow;
      unsigned char     cmd_buf;
      unsigned char     rcv_buf_0, rcv_buf_1, rcv_buf_2;
      unsigned char     xmit_buf_0, xmit_buf_1, xmit_buf_2;
} cistpl_modem_cap_t;

#define CISTPL_SERIAL_MOD_103       0x01
#define CISTPL_SERIAL_MOD_V21       0x02
#define CISTPL_SERIAL_MOD_V23       0x04
#define CISTPL_SERIAL_MOD_V22       0x08
#define CISTPL_SERIAL_MOD_212A            0x10
#define CISTPL_SERIAL_MOD_V22BIS    0x20
#define CISTPL_SERIAL_MOD_V26       0x40
#define CISTPL_SERIAL_MOD_V26BIS    0x80
#define CISTPL_SERIAL_MOD_V27BIS    0x01
#define CISTPL_SERIAL_MOD_V29       0x02
#define CISTPL_SERIAL_MOD_V32       0x04
#define CISTPL_SERIAL_MOD_V32BIS    0x08
#define CISTPL_SERIAL_MOD_V34       0x10

#define CISTPL_SERIAL_ERR_MNP2_4    0x01
#define CISTPL_SERIAL_ERR_V42_LAPM  0x02

#define CISTPL_SERIAL_CMPR_V42BIS   0x01
#define CISTPL_SERIAL_CMPR_MNP5           0x02

#define CISTPL_SERIAL_CMD_AT1       0x01
#define CISTPL_SERIAL_CMD_AT2       0x02
#define CISTPL_SERIAL_CMD_AT3       0x04
#define CISTPL_SERIAL_CMD_MNP_AT    0x08
#define CISTPL_SERIAL_CMD_V25BIS    0x10
#define CISTPL_SERIAL_CMD_V25A            0x20
#define CISTPL_SERIAL_CMD_DMCL            0x40

00248 typedef struct cistpl_data_serv_t {
      unsigned char     max_data_0;
      unsigned char     max_data_1;
      unsigned char     modulation_0;
      unsigned char     modulation_1;
      unsigned char     error_control;
      unsigned char     compression;
      unsigned char     cmd_protocol;
      unsigned char     escape;
      unsigned char     encrypt;
      unsigned char     misc_features;
      unsigned char     ccitt_code[0];
} cistpl_data_serv_t;

00262 typedef struct cistpl_fax_serv_t {
      unsigned char     max_data_0;
      unsigned char     max_data_1;
      unsigned char     modulation;
      unsigned char     encrypt;
      unsigned char     features_0;
      unsigned char     features_1;
      unsigned char     ccitt_code[0];
} cistpl_fax_serv_t;

00272 typedef struct cistpl_voice_serv_t {
      unsigned char     max_data_0;
      unsigned char     max_data_1;
} cistpl_voice_serv_t;

/*======================================================================

    LAN Function Extension Tuples

======================================================================*/

#define CISTPL_FUNCE_LAN_TECH       0x01
#define CISTPL_FUNCE_LAN_SPEED            0x02
#define CISTPL_FUNCE_LAN_MEDIA            0x03
#define CISTPL_FUNCE_LAN_NODE_ID    0x04
#define CISTPL_FUNCE_LAN_CONNECTOR  0x05

/* LAN technologies */
#define CISTPL_LAN_TECH_ARCNET            0x01
#define CISTPL_LAN_TECH_ETHERNET    0x02
#define CISTPL_LAN_TECH_TOKENRING   0x03
#define CISTPL_LAN_TECH_LOCALTALK   0x04
#define CISTPL_LAN_TECH_FDDI        0x05
#define CISTPL_LAN_TECH_ATM         0x06
#define CISTPL_LAN_TECH_WIRELESS    0x07

00298 typedef struct cistpl_lan_tech_t {
      unsigned char     tech;
} cistpl_lan_tech_t;

00302 typedef struct cistpl_lan_speed_t {
      unsigned int      speed;
} cistpl_lan_speed_t;

/* LAN media definitions */
#define CISTPL_LAN_MEDIA_UTP        0x01
#define CISTPL_LAN_MEDIA_STP        0x02
#define CISTPL_LAN_MEDIA_THIN_COAX  0x03
#define CISTPL_LAN_MEDIA_THICK_COAX 0x04
#define CISTPL_LAN_MEDIA_FIBER            0x05
#define CISTPL_LAN_MEDIA_900MHZ           0x06
#define CISTPL_LAN_MEDIA_2GHZ       0x07
#define CISTPL_LAN_MEDIA_5GHZ       0x08
#define CISTPL_LAN_MEDIA_DIFF_IR    0x09
#define CISTPL_LAN_MEDIA_PTP_IR           0x0a

00318 typedef struct cistpl_lan_media_t {
      unsigned char     media;
} cistpl_lan_media_t;

00322 typedef struct cistpl_lan_node_id_t {
      unsigned char     nb;
      unsigned char     id[16];
} cistpl_lan_node_id_t;

00327 typedef struct cistpl_lan_connector_t {
      unsigned char     code;
} cistpl_lan_connector_t;

/*======================================================================

    IDE Function Extension Tuples

======================================================================*/

#define CISTPL_IDE_INTERFACE        0x01

00339 typedef struct cistpl_ide_interface_t {
      unsigned char     interface;
} cistpl_ide_interface_t;

/* First feature byte */
#define CISTPL_IDE_SILICON          0x04
#define CISTPL_IDE_UNIQUE           0x08
#define CISTPL_IDE_DUAL             0x10

/* Second feature byte */
#define CISTPL_IDE_HAS_SLEEP        0x01
#define CISTPL_IDE_HAS_STANDBY            0x02
#define CISTPL_IDE_HAS_IDLE         0x04
#define CISTPL_IDE_LOW_POWER        0x08
#define CISTPL_IDE_REG_INHIBIT            0x10
#define CISTPL_IDE_HAS_INDEX        0x20
#define CISTPL_IDE_IOIS16           0x40

00357 typedef struct cistpl_ide_feature_t {
      unsigned char     feature1;
      unsigned char     feature2;
} cistpl_ide_feature_t;

#define CISTPL_FUNCE_IDE_IFACE            0x01
#define CISTPL_FUNCE_IDE_MASTER           0x02
#define CISTPL_FUNCE_IDE_SLAVE            0x03

/*======================================================================

    Configuration Table Entries

======================================================================*/

#define CISTPL_BAR_SPACE      0x07
#define CISTPL_BAR_SPACE_IO   0x10
#define CISTPL_BAR_PREFETCH   0x20
#define CISTPL_BAR_CACHEABLE  0x40
#define CISTPL_BAR_1MEG_MAP   0x80

00378 typedef struct cistpl_bar_t {
      unsigned char     attr;
      unsigned int      size;
} cistpl_bar_t;

00383 typedef struct cistpl_config_t {
      unsigned char     last_idx;
      unsigned int      base;
      unsigned int      rmask[4];
      unsigned char     subtuples;
} cistpl_config_t;

/* These are bits in the 'present' field, and indices in 'param' */
#define CISTPL_POWER_VNOM     0
#define CISTPL_POWER_VMIN     1
#define CISTPL_POWER_VMAX     2
#define CISTPL_POWER_ISTATIC  3
#define CISTPL_POWER_IAVG     4
#define CISTPL_POWER_IPEAK    5
#define CISTPL_POWER_IDOWN    6

#define CISTPL_POWER_HIGHZ_OK 0x01
#define CISTPL_POWER_HIGHZ_REQ      0x02

00402 typedef struct cistpl_power_t {
      unsigned char     present;
      unsigned char     flags;
      unsigned int      param[7];
} cistpl_power_t;

00408 typedef struct cistpl_timing_t {
      unsigned int      wait, waitscale;
      unsigned int      ready, rdyscale;
      unsigned int      reserved, rsvscale;
} cistpl_timing_t;

#define CISTPL_IO_LINES_MASK  0x1f
#define CISTPL_IO_8BIT        0x20
#define CISTPL_IO_16BIT       0x40
#define CISTPL_IO_RANGE       0x80

#define CISTPL_IO_MAX_WIN     16

00421 typedef struct cistpl_io_t {
      unsigned char     flags;
      unsigned char     nwin;
      struct {
            unsigned int      base;
            unsigned int      len;
      } win[CISTPL_IO_MAX_WIN];
} cistpl_io_t;

00430 typedef struct cistpl_irq_t {
      unsigned int      IRQInfo1;
      unsigned int      IRQInfo2;
} cistpl_irq_t;

#define CISTPL_MEM_MAX_WIN    8

00437 typedef struct cistpl_mem_t {
      unsigned char     flags;
      unsigned char     nwin;
      struct {
            unsigned int      len;
            unsigned int      card_addr;
            unsigned int      host_addr;
      } win[CISTPL_MEM_MAX_WIN];
} cistpl_mem_t;

#define CISTPL_CFTABLE_DEFAULT            0x0001
#define CISTPL_CFTABLE_BVDS         0x0002
#define CISTPL_CFTABLE_WP           0x0004
#define CISTPL_CFTABLE_RDYBSY       0x0008
#define CISTPL_CFTABLE_MWAIT        0x0010
#define CISTPL_CFTABLE_AUDIO        0x0800
#define CISTPL_CFTABLE_READONLY           0x1000
#define CISTPL_CFTABLE_PWRDOWN            0x2000

00456 typedef struct cistpl_cftable_entry_t {
      unsigned char           index;
      unsigned short          flags;
      unsigned char           interface;
      cistpl_power_t    vcc, vpp1, vpp2;
      cistpl_timing_t   timing;
      cistpl_io_t       io;
      cistpl_irq_t      irq;
      cistpl_mem_t      mem;
      unsigned char           subtuples;
} cistpl_cftable_entry_t;

#define CISTPL_CFTABLE_MASTER       0x000100
#define CISTPL_CFTABLE_INVALIDATE   0x000200
#define CISTPL_CFTABLE_VGA_PALETTE  0x000400
#define CISTPL_CFTABLE_PARITY       0x000800
#define CISTPL_CFTABLE_WAIT         0x001000
#define CISTPL_CFTABLE_SERR         0x002000
#define CISTPL_CFTABLE_FAST_BACK    0x004000
#define CISTPL_CFTABLE_BINARY_AUDIO 0x010000
#define CISTPL_CFTABLE_PWM_AUDIO    0x020000

00478 typedef struct cistpl_cftable_entry_cb_t {
      unsigned char           index;
      unsigned int            flags;
      cistpl_power_t    vcc, vpp1, vpp2;
      unsigned char           io;
      cistpl_irq_t      irq;
      unsigned char           mem;
      unsigned char           subtuples;
} cistpl_cftable_entry_cb_t;

00488 typedef struct cistpl_device_geo_t {
      unsigned char           ngeo;
      struct {
            unsigned char           buswidth;
            unsigned int            erase_block;
            unsigned int            read_block;
            unsigned int            write_block;
            unsigned int            partition;
            unsigned int            interleave;
      } geo[CISTPL_MAX_DEVICES];
} cistpl_device_geo_t;

00500 typedef struct cistpl_vers_2_t {
      unsigned char     vers;
      unsigned char     comply;
      unsigned short    dindex;
      unsigned char     vspec8, vspec9;
      unsigned char     nhdr;
      unsigned char     vendor, info;
      char  str[244];
} cistpl_vers_2_t;

00510 typedef struct cistpl_org_t {
      unsigned char     data_org;
      char  desc[30];
} cistpl_org_t;

#define CISTPL_ORG_FS         0x00
#define CISTPL_ORG_APPSPEC    0x01
#define CISTPL_ORG_XIP        0x02

00519 typedef struct cistpl_format_t {
      unsigned char     type;
      unsigned char     edc;
      unsigned int      offset;
      unsigned int      length;
} cistpl_format_t;

#define CISTPL_FORMAT_DISK    0x00
#define CISTPL_FORMAT_MEM     0x01

#define CISTPL_EDC_NONE       0x00
#define CISTPL_EDC_CKSUM      0x01
#define CISTPL_EDC_CRC        0x02
#define CISTPL_EDC_PCC        0x03

00534 typedef union cisparse_t {
      cistpl_device_t         device;
      cistpl_checksum_t       checksum;
      cistpl_longlink_t       longlink;
      cistpl_longlink_mfc_t   longlink_mfc;
      cistpl_vers_1_t         version_1;
      cistpl_altstr_t         altstr;
      cistpl_jedec_t          jedec;
      cistpl_manfid_t         manfid;
      cistpl_funcid_t         funcid;
      cistpl_funce_t          funce;
      cistpl_bar_t            bar;
      cistpl_config_t         config;
      cistpl_cftable_entry_t  cftable_entry;
      cistpl_cftable_entry_cb_t     cftable_entry_cb;
      cistpl_device_geo_t           device_geo;
      cistpl_vers_2_t         vers_2;
      cistpl_org_t            org;
      cistpl_format_t         format;
} cisparse_t;

00555 typedef struct tuple_flags {
      unsigned int               link_space:4;
      unsigned int               has_link:1;
      unsigned int               mfc_fn:3;
      unsigned int               space:4;
} tuple_flags;

00562 typedef struct tuple_t {
      unsigned int      Attributes;
      unsigned char     DesiredTuple;
      tuple_flags       Flags;            /* internal use */
      unsigned int      LinkOffset; /* internal use */
      unsigned int      CISOffset;  /* internal use */
      unsigned char     TupleCode;
      unsigned char     TupleLink;
      unsigned char     TupleOffset;
      unsigned char     TupleDataMax;
      unsigned char     TupleDataLen;
      unsigned char     *TupleData;
} tuple_t;

/* Special unsigned char value */
#define RETURN_FIRST_TUPLE    0xff

/* Attributes for tuple calls */
#define TUPLE_RETURN_LINK     0x01
#define TUPLE_RETURN_COMMON   0x02

/* For ValidateCIS */
00584 typedef struct cisinfo_t {
      unsigned int      Chains;
} cisinfo_t;

#define CISTPL_MAX_CIS_SIZE   0x200

/* For ReplaceCIS */
00591 typedef struct cisdump_t {
      unsigned int      Length;
      unsigned char     Data[CISTPL_MAX_CIS_SIZE];
} cisdump_t;

#define BIND_FN_ALL        0xff

int read_out_cis(unsigned int socket_no, FILE *fd);
int pcmcia_get_first_tuple(unsigned int function, tuple_t *tuple);
int pcmcia_get_next_tuple(unsigned int function, tuple_t *tuple);
int pcmcia_get_tuple_data(tuple_t *tuple);
int pccard_parse_tuple(tuple_t *tuple, cisparse_t *parse);

#endif /* LINUX_CISTPL_H */

Generated by  Doxygen 1.6.0   Back to index