retronetworking
/
wanpipe
13
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
wanpipe/patches/kdrivers/include/sdlasfm.h

367 lines
13 KiB
C
Raw Blame History

/*****************************************************************************
* sdlasfm.h WANPIPE(tm) Multiprotocol WAN Link Driver.
* Definitions for the SDLA Firmware Module (SFM).
*
* Author: Gideon Hack
*
* Copyright: (c) 1995-1999 Sangoma Technologies Inc.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version
* 2 of the License, or (at your option) any later version.
* ============================================================================
* Jun 02, 1999 Gideon Hack Added support for the S514 adapter.
* Dec 11, 1996 Gene Kozin Cosmetic changes
* Apr 16, 1996 Gene Kozin Changed adapter & firmware IDs. Version 2
* Dec 15, 1995 Gene Kozin Structures chaned
* Nov 09, 1995 Gene Kozin Initial version.
*****************************************************************************/
#ifndef _SDLASFM_H
#define _SDLASFM_H
/****** Defines *************************************************************/
#define SFM_VERSION 2
#define SFM_SIGNATURE "SFM - Sangoma SDLA Firmware Module"
/* min/max */
#define SFM_IMAGE_SIZE 0x8000 /* max size of SDLA code image file */
#define SFM_DESCR_LEN 256 /* max length of description string */
#define SFM_MAX_SDLA 16 /* max number of compatible adapters */
/* Adapter types */
#define SDLA_S502A 5020
#define SDLA_S502E 5021
#define SDLA_S503 5030
#define SDLA_S508 5080
#define SDLA_S507 5070
#define SDLA_S509 5090
#define SDLA_S514 5140
#define SDLA_ADSL 6000
#define SDLA_AFT 7000
#define SDLA_USB 7001
/* S514 PCI adapter CPU numbers */
#define S514_CPU_A 'A'
#define S514_CPU_B 'B'
#define SDLA_CPU_A 1
#define SDLA_CPU_B 2
#define SDLA_GET_CPU(cpu_no) (cpu_no==SDLA_CPU_A)?S514_CPU_A:S514_CPU_B
/* Firmware identification numbers:
* 0 .. 999 Test & Diagnostics
* 1000 .. 1999 Streaming HDLC
* 2000 .. 2999 Bisync
* 3000 .. 3999 SDLC
* 4000 .. 4999 HDLC
* 5000 .. 5999 X.25
* 6000 .. 6999 Frame Relay
* 7000 .. 7999 PPP
* 8000 .. 8999 Cisco HDLC
*/
#define SFID_CALIB502 200
#define SFID_STRM502 1200
#define SFID_STRM508 1800
#define SFID_BSC502 2200
#define SFID_BSCMP514 2201
#define SFID_SDLC502 3200
#define SFID_HDLC502 4200
#define SFID_HDLC508 4800
#define SFID_X25_502 5200
#define SFID_X25_508 5800
#define SFID_FR502 6200
#define SFID_FR508 6800
#define SFID_PPP502 7200
#define SFID_PPP508 7800
#define SFID_PPP514 7140
#define SFID_CHDLC508 8800
#define SFID_CHDLC514 8140
#define SFID_BITSTRM 10000
#define SFID_EDU_KIT 8141
#define SFID_SS7514 9000
#define SFID_BSCSTRM 2205
#define SFID_ADSL 20000
#define SFID_SDLC514 3300
#define SFID_ATM 11000
#define SFID_POS 12000
#define SFID_ADCCP 13000
#define SFID_AFT 30000
/****** Data Types **********************************************************/
typedef struct sfm_info /* firmware module information */
{
unsigned short codeid; /* firmware ID */
unsigned short version; /* firmaware version number */
unsigned short adapter[SFM_MAX_SDLA]; /* compatible adapter types */
unsigned int memsize; /* minimum memory size */
unsigned short reserved[2]; /* reserved */
unsigned short startoffs; /* entry point offset */
unsigned short winoffs; /* dual-port memory window offset */
unsigned short codeoffs; /* code load offset */
unsigned short codesize; /* code size */
unsigned short dataoffs; /* configuration data load offset */
unsigned short datasize; /* configuration data size */
} sfm_info_t;
typedef struct sfm /* SDLA firmware file structire */
{
char signature[80]; /* SFM file signature */
unsigned short version; /* file format version */
unsigned short checksum; /* info + image */
unsigned short reserved[6]; /* reserved */
char descr[SFM_DESCR_LEN]; /* description string */
sfm_info_t info; /* firmware module info */
unsigned char image[1]; /* code image (variable size) */
} sfm_t;
/* settings for the 'adapter_type' */
enum {
S5141_ADPTR_1_CPU_SERIAL = 0x01,/* S5141, single CPU, serial */
S5142_ADPTR_2_CPU_SERIAL, /* S5142, dual CPU, serial */
S5143_ADPTR_1_CPU_FT1, /* S5143, single CPU, FT1 */
S5144_ADPTR_1_CPU_T1E1, /* S5144, single CPU, T1/E1 */
S5145_ADPTR_1_CPU_56K, /* S5145, single CPU, 56K */
S5147_ADPTR_2_CPU_T1E1, /* S5147, dual CPU, T1/E1 */
S5148_ADPTR_1_CPU_T1E1, /* S5148, single CPU, T1/E1 */
S518_ADPTR_1_CPU_ADSL, /* S518, adsl card */
A101_ADPTR_1TE1, /* 1 Channel T1/E1 */
A101_ADPTR_2TE1, /* 2 Channels T1/E1 */
A104_ADPTR_4TE1, /* Quad line T1/E1 */
A104_ADPTR_4TE1_PCIX, /* Quad line T1/E1 PCI Express */
A108_ADPTR_8TE1, /* 8 Channels T1/E1 */
A100_ADPTR_U_1TE3, /* 1 Channel T3/E3 (Proto) */
A300_ADPTR_U_1TE3, /* 1 Channel T3/E3 (unchannelized) */
A305_ADPTR_C_1TE3, /* 1 Channel T3/E3 (channelized) */
A200_ADPTR_ANALOG, /* AFT-200 REMORA analog board */
A400_ADPTR_ANALOG, /* AFT-400 REMORA analog board */
AFT_ADPTR_ISDN, /* AFT ISDN BRI board */
AFT_ADPTR_56K, /* AFT 56K board */
AFT_ADPTR_2SERIAL_V35X21, /* AFT-A142 2 Port V.35/X.21 board */
AFT_ADPTR_4SERIAL_V35X21, /* AFT-A144 4 Port V.35/X.21 board */
AFT_ADPTR_2SERIAL_RS232, /* AFT-A142 2 Port RS232 board */
AFT_ADPTR_4SERIAL_RS232, /* AFT-A144 4 Port RS232 board */
U100_ADPTR, /* USB board */
AFT_ADPTR_A600, /* AFT-A600 board */
AFT_ADPTR_B601, /* AFT-B601 board */
AFT_ADPTR_B800, /* AFT-B800 board */
AFT_ADPTR_FLEXBRI, /* AFT-A700 FlexBRI board */
AFT_ADPTR_LAST /* NOTE: Keep it as a last line */
};
#define MAX_ADPTRS AFT_ADPTR_LAST
#define OPERATE_T1E1_AS_SERIAL 0x8000 /* For bitstreaming only
* Allow the applicatoin to
* E1 front end */
/* settings for the 'adapter_subtype' */
#define AFT_SUBTYPE_NORMAL 0x00
#define AFT_SUBTYPE_SHARK 0x01
#define IS_ADPTR_SHARK(type) ((type) == AFT_SUBTYPE_SHARK)
/* settings for the 'adapter_security' */
#define AFT_SECURITY_NONE 0x00
#define AFT_SECURITY_CHAN 0x01
#define AFT_SECURITY_UNCHAN 0x02
/* settings for the 'adptr_subtype' */
#define AFT_SUBTYPE_SHIFT 8
#define AFT_SUBTYPE_MASK 0x0F
/* CPLD interface */
#define AFT_MCPU_INTERFACE_ADDR 0x46
#define AFT_MCPU_INTERFACE 0x44
#define AFT56K_MCPU_INTERFACE_ADDR 0x46
#define AFT56K_MCPU_INTERFACE 0x44
/* CPLD definitions */
#define AFT_SECURITY_1LINE_UNCH 0x00
#define AFT_SECURITY_1LINE_CH 0x01
#define AFT_SECURITY_2LINE_UNCH 0x02
#define AFT_SECURITY_2LINE_CH 0x03
#define AFT_BIT_DEV_ADDR_CLEAR 0x600
#define AFT_BIT_DEV_ADDR_CPLD 0x200
#define AFT4_BIT_DEV_ADDR_CLEAR 0x800
#define AFT4_BIT_DEV_ADDR_CPLD 0x800
#define AFT56K_BIT_DEV_ADDR_CPLD 0x800
/* Maxim CPLD definitions */
#define AFT8_BIT_DEV_ADDR_CLEAR 0x1800 /* QUAD */
#define AFT8_BIT_DEV_ADDR_CPLD 0x800
#define AFT8_BIT_DEV_MAXIM_ADDR_CPLD 0x1000
/* Aft Serial CPLD definitions */
#define AFT_SERIAL_BIT_DEV_ADDR_CLEAR 0x1800 /* QUAD */
#define AFT_SERIAL_BIT_DEV_ADDR_CPLD 0x800
#define AFT_SERIAL_BIT_DEV_MAXIM_ADDR_CPLD 0x1000
#define AFT3_BIT_DEV_ADDR_EXAR_CLEAR 0x600
#define AFT3_BIT_DEV_ADDR_EXAR_CPLD 0x400
#define AFT_SECURITY_CPLD_REG 0x09
#define AFT_SECURITY_CPLD_SHIFT 0x02
#define AFT_SECURITY_CPLD_MASK 0x03
#define AFT_A300_VER_CUSTOMER_ID 0x0A
#define AFT_A300_VER_SHIFT 6
#define AFT_A300_VER_MASK 0x03
#define AFT_A300_CUSTOMER_ID_SHIFT 0
#define AFT_A300_CUSTOMER_ID_MASK 0x3F
/* AFT SHARK CPLD */
#define AFT_SH_CPLD_BOARD_CTRL_REG 0x00
#define AFT_SH_CPLD_BOARD_STATUS_REG 0x01
#define A200_SH_CPLD_BOARD_STATUS_REG 0x09
#define AFT_SH_SECURITY_MASK 0x07
#define AFT_SH_SECURITY_SHIFT 1
#define AFT_SH_SECURITY(reg) \
(((reg) >> AFT_SH_SECURITY_SHIFT) & AFT_SH_SECURITY_MASK)
#define A104_SECURITY_32_ECCHAN 0x00
#define A104_SECURITY_64_ECCHAN 0x01
#define A104_SECURITY_96_ECCHAN 0x02
#define A104_SECURITY_128_ECCHAN 0x03
#define A104_SECURITY_256_ECCHAN 0x04
#define A104_SECURITY_PROTO_128_ECCHAN 0x05
#define A104_SECURITY_0_ECCHAN 0x07
#define A108_SECURITY_32_ECCHAN 0x00
#define A108_SECURITY_64_ECCHAN 0x01
#define A108_SECURITY_96_ECCHAN 0x02
#define A108_SECURITY_128_ECCHAN 0x03
#define A108_SECURITY_256_ECCHAN 0x04
#define A108_SECURITY_0_ECCHAN 0x05
#define A500_SECURITY_16_ECCHAN 0x00
#define A500_SECURITY_64_ECCHAN 0x01
#define A500_SECURITY_0_ECCHAN 0x05
#define A104_ECCHAN(val) \
((val) == A104_SECURITY_32_ECCHAN) ? 32 : \
((val) == A104_SECURITY_64_ECCHAN) ? 64 : \
((val) == A104_SECURITY_96_ECCHAN) ? 96 : \
((val) == A104_SECURITY_128_ECCHAN) ? 128 : \
((val) == A104_SECURITY_PROTO_128_ECCHAN) ? 128 : \
((val) == A104_SECURITY_256_ECCHAN) ? 256 : 0
#define A108_ECCHAN(val) \
((val) == A108_SECURITY_32_ECCHAN) ? 32 : \
((val) == A108_SECURITY_64_ECCHAN) ? 64 : \
((val) == A108_SECURITY_96_ECCHAN) ? 96 : \
((val) == A108_SECURITY_128_ECCHAN) ? 128 : \
((val) == A108_SECURITY_256_ECCHAN) ? 256 : 0
#define A500_ECCHAN(val) \
((val) == A500_SECURITY_16_ECCHAN) ? 16 : \
((val) == A500_SECURITY_64_ECCHAN) ? 64 : 0
#define AFT_RM_SECURITY_16_ECCHAN 0x00
#define AFT_RM_SECURITY_32_ECCHAN 0x01
#define AFT_RM_SECURITY_0_ECCHAN 0x05
#define AFT_RM_ECCHAN(val) \
((val) == AFT_RM_SECURITY_16_ECCHAN) ? 16 : \
((val) == AFT_RM_SECURITY_32_ECCHAN) ? 32 : 0
#define AFT_A600_SECURITY_00_ECCHAN 0x00
#define AFT_A600_SECURITY_05_ECCHAN 0x01
#define A600_ECCHAN(val) \
((val) == AFT_A600_SECURITY_00_ECCHAN) ? 0 : \
((val) == AFT_A600_SECURITY_05_ECCHAN) ? 5 : 0
#define AFT_B601_SECURITY_00_ECCHAN 0x00
#define AFT_B601_SECURITY_64_ECCHAN 0x01
#define B601_ECCHAN(val) \
((val) == AFT_B601_SECURITY_00_ECCHAN) ? 0 : \
((val) == AFT_B601_SECURITY_64_ECCHAN) ? 64 : 0
#define SDLA_ADPTR_NAME(adapter_type) \
(adapter_type == S5141_ADPTR_1_CPU_SERIAL) ? "S514-1-PCI" : \
(adapter_type == S5142_ADPTR_2_CPU_SERIAL) ? "S514-2-PCI" : \
(adapter_type == S5143_ADPTR_1_CPU_FT1) ? "S514-3-PCI" : \
(adapter_type == S5144_ADPTR_1_CPU_T1E1) ? "S514-4-PCI" : \
(adapter_type == S5145_ADPTR_1_CPU_56K) ? "S514-5-PCI" : \
(adapter_type == S5147_ADPTR_2_CPU_T1E1) ? "S514-7-PCI" : \
(adapter_type == S518_ADPTR_1_CPU_ADSL) ? "S518-PCI" : \
(adapter_type == A101_ADPTR_1TE1) ? "AFT-A101" : \
(adapter_type == A101_ADPTR_2TE1) ? "AFT-A102" : \
(adapter_type == A104_ADPTR_4TE1) ? "AFT-A104" : \
(adapter_type == A108_ADPTR_8TE1) ? "AFT-A108" : \
(adapter_type == A300_ADPTR_U_1TE3) ? "AFT-A301" : \
(adapter_type == A200_ADPTR_ANALOG) ? "AFT-A200" : \
(adapter_type == A400_ADPTR_ANALOG) ? "AFT-A400" : \
(adapter_type == AFT_ADPTR_ISDN) ? "AFT-A500" : \
(adapter_type == AFT_ADPTR_56K) ? "AFT-A056" : \
(adapter_type == AFT_ADPTR_2SERIAL_V35X21) ? "AFT-A142" : \
(adapter_type == AFT_ADPTR_4SERIAL_V35X21) ? "AFT-A144" : \
(adapter_type == AFT_ADPTR_2SERIAL_RS232) ? "AFT-A142" : \
(adapter_type == AFT_ADPTR_4SERIAL_RS232) ? "AFT-A144" : \
(adapter_type == U100_ADPTR) ? "U100" : \
(adapter_type == AFT_ADPTR_A600) ? "AFT-B600" : \
(adapter_type == AFT_ADPTR_B601) ? "AFT-B601" : \
(adapter_type == AFT_ADPTR_B800) ? "AFT-B800" : \
(adapter_type == AFT_ADPTR_FLEXBRI) ? "AFT-B700" : \
"UNKNOWN"
#define AFT_GET_SECURITY(security) \
((security >> AFT_SECURITY_CPLD_SHIFT) & AFT_SECURITY_CPLD_MASK)
#define AFT_SECURITY(adapter_security) \
(adapter_security == AFT_SECURITY_CHAN) ? "c" : \
(adapter_security == AFT_SECURITY_UNCHAN) ? "u" : ""
#define AFT_SECURITY_DECODE(adapter_security) \
(adapter_security == AFT_SECURITY_CHAN) ? "Channelized" : \
(adapter_security == AFT_SECURITY_UNCHAN) ? "Unchannelized" : ""
#define AFT_SUBTYPE(adptr_subtype) \
(adptr_subtype == AFT_SUBTYPE_NORMAL) ? "" : \
(adptr_subtype == AFT_SUBTYPE_SHARK) ? "-SH" : ""
#define AFT_SUBTYPE_DECODE(adptr_subtype) \
(adptr_subtype == AFT_SUBTYPE_NORMAL) ? "" : \
(adptr_subtype == AFT_SUBTYPE_SHARK) ? "SHARK" : ""
#define AFT_PCITYPE_DECODE(hwcard) \
((hwcard)->u_pci.pci_bridge_dev) ? "PCIe" : "PCI"
#if defined(__WINDOWS__)
#define AFT_PCIBRIDGE_DECODE(hwcard) "not defined"
#else
#define AFT_PCIBRIDGE_DECODE(hwcard) \
(!(hwcard)->u_pci.pci_bridge_dev) ? "NONE" : \
((hwcard)->u_pci.pci_bridge_dev->vendor == PLX_VENDOR_ID && \
(hwcard)->u_pci.pci_bridge_dev->device == PLX_DEVICE_ID) ? "PLX1" : \
((hwcard)->u_pci.pci_bridge_dev->vendor == PLX_VENDOR_ID && \
(hwcard)->u_pci.pci_bridge_dev->device == PLX2_DEVICE_ID) ? "PLX2" : \
((hwcard)->u_pci.pci_bridge_dev->vendor == TUNDRA_VENDOR_ID && \
(hwcard)->u_pci.pci_bridge_dev->device == TUNDRA_DEVICE_ID) ? "TUND" : "NONE"
#endif
#if defined(__WINDOWS__)
#define DECODE_CARD_SUBTYPE(card_sub_type) \
(card_sub_type == A101_1TE1_SUBSYS_VENDOR) ? "A101" : \
(card_sub_type == AFT_1TE1_SHARK_SUBSYS_VENDOR) ? "A101D" : \
(card_sub_type == A101_2TE1_SUBSYS_VENDOR) ? "A102" : \
(card_sub_type == AFT_2TE1_SHARK_SUBSYS_VENDOR) ? "A102D" : \
(card_sub_type == A104_4TE1_SUBSYS_VENDOR) ? "A104" : \
(card_sub_type == AFT_4TE1_SHARK_SUBSYS_VENDOR) ? "A104D" : \
(card_sub_type == AFT_8TE1_SHARK_SUBSYS_VENDOR) ? "A108D" : \
(card_sub_type == AFT_ADPTR_FLEXBRI) ? "B700" : \
(card_sub_type == A200_REMORA_SHARK_SUBSYS_VENDOR)? "A200" : "Unknown"
#define SDLA_CARD_TYPE_DECODE(cardtype) \
((cardtype == SDLA_S514) ? "S514" : \
(cardtype == SDLA_ADSL) ? "S518-ADSL" : \
(cardtype == SDLA_AFT) ? "AFT" : "Invalid card")
#endif/* __WINDOWS__ */
#endif /* _SDLASFM_H */
Reference in New Issue View Git Blame Copy Permalink