wanpipe/patches/kdrivers/include/sdladrv.h

577 lines
17 KiB
C

/*
* Copyright (c) 1997, 1998, 1999
* Alex Feldman <al.feldman@sangoma.com>. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. All advertising materials mentioning features or use of this software
* must display the following acknowledgement:
* This product includes software developed by Alex Feldman.
* 4. Neither the name of the author nor the names of any co-contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY Alex Feldman AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL Alex Feldman OR THE VOICES IN HIS HEAD
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*
* $Id: sdladrv.h,v 1.47 2005/11/10 18:02:32 sangoma Exp $
*/
/*****************************************************************************
* sdladrv.h SDLA Support Module. Kernel API Definitions.
*
* Author: Alex Feldman <al.feldman@sangoma.com>
*
* ============================================================================
* Dec 06, 1999 Alex Feldman Updated to FreeBSD 3.2
* Dec 06, 1995 Gene Kozin Initial version.
*****************************************************************************
*/
#ifndef _SDLADRV_H
# define _SDLADRV_H
#ifdef __SDLADRV__
# define EXTERN
#else
# define EXTERN extern
#endif
/*
******************************************************************
** I N C L U D E S **
******************************************************************
*/
#if defined(__LINUX__)
# include <linux/version.h>
# include <linux/wanpipe_kernel.h>
#endif
/*
******************************************************************
** D E F I N E S **
******************************************************************
*/
#define SDLADRV_MAGIC 0x414C4453L /* signature: 'SDLA' reversed */
#define SDLADRV_MAJOR_VER 2
#define SDLADRV_MINOR_VER 1
#define SDLA_MAXIORANGE 4 /* maximum I/O port range */
#define SDLA_WINDOWSIZE 0x2000 /* default dual-port memory window size */
/* */
#define SDLA_MEMBASE 0x01
#define SDLA_MEMEND 0x02
#define SDLA_MEMSIZE 0x03
#define SDLA_IRQ 0x04
#define SDLA_ADAPTERTYPE 0x05
#define SDLA_CPU 0x06
#define SDLA_SLOT 0x07
#define SDLA_IOPORT 0x08
#define SDLA_IORANGE 0x09
#define SDLA_CARDTYPE 0x0A
#define SDLA_DMATAG 0x0B
#define SDLA_MEMORY 0x0C
#define SDLA_PCIEXTRAVER 0x0D
#define SDLA_HWTYPE 0x0E
#define SDLA_BUS 0x0F
#define SDLA_BASEADDR 0x10
#define SDLA_COREREV 0x11
#define SDLA_USEDCNT 0x12
#define SDLA_ADAPTERSUBTYPE 0x13
#define SDLA_MAX_CPUS 2
#define SDLA_MAX_PORTS 4 /* Serial card - 2, AFT-Quad - 4 */
/* Status values */
#define SDLA_MEM_RESERVED 0x0001
#define SDLA_MEM_MAPPED 0x0002
#define SDLA_IO_MAPPED 0x0004
#define SDLA_PCI_ENABLE 0x0008
#define SDLA_NAME_SIZE 20
/*
******************************************************************
** T Y P E D E F S **
******************************************************************
*/
#if defined(__FreeBSD__)
typedef void* sdla_mem_handle_t;
# if (__FreeBSD_version < 400000)
typedef bus_addr_t sdla_base_addr_t;
typedef bus_addr_t sdla_dma_addr_t;
typedef pcici_t sdla_pci_dev_t;
# else
typedef uint32_t sdla_base_addr_t;
typedef uint32_t sdla_dma_addr_t;
typedef struct device* sdla_pci_dev_t;
# endif
#elif defined(__OpenBSD__)
typedef bus_space_handle_t sdla_mem_handle_t;
typedef bus_addr_t sdla_base_addr_t;
typedef bus_addr_t sdla_dma_addr_t;
typedef struct pci_attach_args* sdla_pci_dev_t;
#elif defined(__NetBSD__)
typedef bus_space_handle_t sdla_mem_handle_t;
typedef bus_addr_t sdla_base_addr_t;
typedef bus_addr_t sdla_dma_addr_t;
typedef struct pci_attach_args* sdla_pci_dev_t;
#elif defined(__LINUX__)
#if defined(__iomem)
typedef void __iomem* sdla_mem_handle_t;
#else
typedef void * sdla_mem_handle_t;
#endif
typedef unsigned long sdla_base_addr_t;
typedef dma_addr_t sdla_dma_addr_t;
typedef struct pci_dev* sdla_pci_dev_t;
#else
# warning "Undefined types sdla_mem_handle_t/sdla_base_addr_t!"
#endif
/*
******************************************************************
** M A C R O S **
******************************************************************
*/
#if defined(__FreeBSD__)
# define virt_to_phys(x) kvtop((caddr_t)x)
# define phys_to_virt(x) (sdla_mem_handle_t)x
#elif defined(__OpenBSD__)
# define virt_to_phys(x) kvtop((caddr_t)x)
# define phys_to_virt(x) (bus_space_handle_t)x
#elif defined(__NetBSD__)
# define virt_to_phys(x) kvtop((caddr_t)x)
# define phys_to_virt(x) (bus_space_handle_t)x
#elif defined(__LINUX__)
#else
# warning "Undefined virt_to_phys/phys_to_virt macros!"
#endif
#define IS_SDLA_PCI(hw) (hw->type == SDLA_S514 || hw->type == SDLA_ADSL)
#define IS_SDLA_ISA(hw) (hw->type == SDLA_S508)
#define AFT_CORE_ID_DECODE(core_id) \
(core_id == AFT_HDLC_CORE_ID) ? "HDLC" : \
(core_id == AFT_ATM_CORE_ID) ? "ATM" : \
(core_id == AFT_SS7_CORE_ID) ? "SS7" : \
"Unknown"
#define WAN_HWCALL(func, x) \
if (card->hw_iface.func){ \
card->hw_iface.func x; \
}else{ \
DEBUG_EVENT("%s: Unknown hw function pointer (%s:%d)!\n",\
card->devname, __FUNCTION__,__LINE__); \
}
/*
******************************************************************
** S T R U C T U R E S **
******************************************************************
*/
typedef struct sdla_hw_probe {
int used;
unsigned char hw_info[100];
WAN_LIST_ENTRY(sdla_hw_probe) next;
} sdla_hw_probe_t;
/*
* This structure keeps common parameters per physical card.
*/
typedef struct sdlahw_card {
int used;
unsigned int hw_type; /* ISA/PCI */
unsigned int type; /* S50x/S514/ADSL/SDLA_AFT */
unsigned char cfg_type; /* Config card type WANOPT_XXX */
unsigned int adptr_type; /* Adapter type (subvendor ID) */
unsigned char adptr_subtype; /* Adapter Subtype (Normal|Shark) */
unsigned char adptr_name[SDLA_NAME_SIZE];
unsigned char core_id; /* SubSystem ID [0..7] */
unsigned char core_rev; /* SubSystem ID [8..15] */
unsigned char pci_extra_ver;
unsigned int slot_no;
unsigned int bus_no;
unsigned int ioport;
#if defined(__LINUX__)
sdla_pci_dev_t pci_dev; /* PCI config header info */
#else
#if defined(__NetBSD__) || defined(__OpenBSD__)
bus_space_tag_t iot; /* adapter I/O port tag */
bus_space_tag_t memt;
#endif
sdla_pci_dev_t pci_dev; /* PCI config header info */
#endif
wan_spinlock_t pcard_lock; /* lock per physical card */
wan_smp_flag_t fe_rw_flag;
unsigned char adptr_security; /* Adapter security (AFT cards) */
WAN_LIST_ENTRY(sdlahw_card) next;
} sdlahw_card_t;
/*-------------------------------------------------------------
*
*/
typedef struct sdlahw_port
{
int used;
char *devname;
sdla_hw_probe_t *hwprobe;
} sdlahw_port_t;
/*----------------------------------------------------------------------------
* Adapter hardware configuration. Pointer to this structure is passed to all
* APIs.
*/
typedef struct sdlahw
{
int used;
char *devname;
u16 status;
unsigned fwid; /* firmware ID */
#if defined(__NetBSD__) || defined(__OpenBSD__)
bus_space_handle_t ioh; /* adapter I/O port handle */
bus_dma_tag_t dmat;
#endif
int irq; /* interrupt request level */
#if (defined(__FreeBSD__) && __FreeBSD_version >= 450000)
void* irqh[SDLA_MAX_PORTS];
#endif
unsigned int cpu_no; /* PCI CPU Number */
unsigned int line_no; /* PCI CPU Number */
char auto_pci_cfg; /* Auto PCI configuration */
sdla_mem_handle_t dpmbase; /* dual-port memory base */
sdla_base_addr_t mem_base_addr;
unsigned dpmsize; /* dual-port memory size */
unsigned pclk; /* CPU clock rate, kHz */
unsigned long memory; /* memory size */
sdla_mem_handle_t vector; /* local offset of the DPM window */
unsigned io_range; /* I/O port range */
unsigned char regs[SDLA_MAXIORANGE]; /* was written to registers */
unsigned reserved[5];
unsigned char hw_info[100];
/* */
unsigned magic;
void* dev; /* used only for FreeBSD/OpenBSD */
u16 configured;
int max_ports;
sdlahw_port_t hwport[SDLA_MAX_PORTS];
sdlahw_card_t* hwcard;
WAN_LIST_ENTRY(sdlahw) next;
} sdlahw_t;
typedef struct sdlahw_iface
{
int (*setup)(void*,wandev_conf_t*);
int (*load)(void*,void*, unsigned);
int (*down)(void*);
int (*start)(sdlahw_t* hw, unsigned addr);
int (*hw_halt)(void*);
int (*intack)(void*, uint32_t);
int (*read_int_stat)(void*, uint32_t*);
int (*mapmem)(void*, unsigned long);
int (*check_mismatch)(void*, unsigned char);
int (*getcfg)(void*, int, void*);
int (*isa_read_1)(void* hw, unsigned int offset, u8*);
int (*isa_write_1)(void* hw, unsigned int offset, u8);
int (*io_write_1)(void* hw, unsigned int offset, u8);
int (*io_read_1)(void* hw, unsigned int offset, u8*);
int (*bus_write_1)(void* hw, unsigned int offset, u8);
int (*bus_write_2)(void* hw, unsigned int offset, u16);
int (*bus_write_4)(void* hw, unsigned int offset, u32);
int (*bus_read_1)(void* hw, unsigned int offset, u8*);
int (*bus_read_2)(void* hw, unsigned int offset, u16*);
int (*bus_read_4)(void* hw, unsigned int offset, u32*);
int (*pci_write_config_byte)(void* hw, int reg, u8 value);
int (*pci_write_config_word)(void* hw, int reg, u16 value);
int (*pci_write_config_dword)(void* hw, int reg, u32 value);
int (*pci_read_config_byte)(void* hw, int reg, u8* value);
int (*pci_read_config_word)(void* hw, int reg, u16* value);
int (*pci_read_config_dword)(void* hw, int reg, u32* value);
int (*cmd)(void* phw, unsigned long offset, wan_mbox_t* mbox);
int (*peek)(void*,unsigned long, void*,unsigned);
int (*poke)(void*,unsigned long, void*,unsigned);
int (*poke_byte)(void*,unsigned long, u8);
int (*set_bit)(void*,unsigned long, u8);
int (*clear_bit)(void*,unsigned long,u8);
int (*set_intrhand)(void*, void (*isr_func)(void*), void*,int);
int (*restore_intrhand)(void*,int);
int (*is_te1)(void*);
int (*is_56k)(void*);
int (*get_hwcard)(void*, void**);
int (*get_hwprobe)(void*, int comm_port, void**);
int (*hw_unlock)(void *phw, wan_smp_flag_t *flag);
int (*hw_lock)(void *phw, wan_smp_flag_t *flag);
int (*hw_same)(void *phw1, void *phw2);
int (*fe_test_and_set_bit)(void *phw);
int (*fe_clear_bit)(void *phw);
sdla_dma_addr_t (*pci_map_dma)(void *phw, void *buf, int len, int ctrl);
int (*pci_unmap_dma)(void *phw, sdla_dma_addr_t buf, int len, int ctrl);
} sdlahw_iface_t;
typedef struct sdla_hw_type_cnt
{
unsigned char s508_adapters;
unsigned char s514x_adapters;
unsigned char s518_adapters;
unsigned char aft101_adapters;
unsigned char aft104_adapters;
unsigned char aft300_adapters;
unsigned char aft_analog_adapters;
}sdla_hw_type_cnt_t;
/****** Function Prototypes *************************************************/
EXTERN unsigned int sdla_hw_probe(void);
EXTERN void *sdla_get_hw_probe (void);
EXTERN void *sdla_get_hw_adptr_cnt(void);
EXTERN void* sdla_register (sdlahw_iface_t* hw_iface, wandev_conf_t*,char*);
EXTERN int sdla_unregister (void**, char*);
#ifdef __SDLADRV__
static __inline unsigned int sdla_get_pci_bus(sdlahw_t* hw)
{
sdlahw_card_t* card;
WAN_ASSERT(hw == NULL);
WAN_ASSERT(hw->hwcard == NULL);
card = hw->hwcard;
#if defined(__FreeBSD__)
# if (__FreeBSD_version > 400000)
return pci_get_bus(card->pci_dev);
# else
return card->pci_dev->bus;
# endif
#elif defined(__NetBSD__) || defined(__OpenBSD__)
return card->pci_dev->pa_bus;
#elif defined(__LINUX__)
return ((struct pci_bus*)card->pci_dev->bus)->number;
#else
# warning "sdla_get_pci_bus: Not supported yet!"
#endif
return 0;
}
static __inline unsigned int sdla_get_pci_slot(sdlahw_t* hw)
{
sdlahw_card_t* card;
WAN_ASSERT(hw == NULL);
WAN_ASSERT(hw->hwcard == NULL);
card = hw->hwcard;
#if defined(__FreeBSD__)
# if (__FreeBSD_version > 400000)
return pci_get_slot(card->pci_dev);
# else
return card->pci_dev->slot;
# endif
#elif defined(__NetBSD__) || defined(__OpenBSD__)
return card->pci_dev->pa_device;
#elif defined(__LINUX__)
return ((card->pci_dev->devfn >> 3) & PCI_DEV_SLOT_MASK);
#else
# warning "sdla_get_pci_slot: Not supported yet!"
#endif
return 0;
}
static __inline int
sdla_bus_space_map(sdlahw_t* hw, int reg, int size, sdla_mem_handle_t* handle)
{
int err = 0;
#if defined(__FreeBSD__)
*handle = (sdla_mem_handle_t)pmap_mapdev(hw->mem_base_addr + reg, size);
#elif defined(__NetBSD__) || defined(__OpenBSD__)
err = bus_space_map(hw->hwcard->memt,
hw->mem_base_addr+reg,
size,
0,
handle);
#elif defined(__LINUX__)
*handle = (sdla_mem_handle_t)ioremap(hw->mem_base_addr+reg, size);
#else
# warning "sdla_bus_space_map: Not supported yet!"
#endif
return err;
}
static __inline void
sdla_bus_space_unmap(sdlahw_t* hw, sdla_mem_handle_t offset, int size)
{
#if defined(__FreeBSD__)
int i = 0;
for (i = 0; i < size; i += PAGE_SIZE){
pmap_kremove((vm_offset_t)offset + i);
}
kmem_free(kernel_map, (vm_offset_t)offset, size);
#elif defined(__NetBSD__) || defined(__OpenBSD__)
bus_space_unmap(hw->hwcard->memt, offset, size);
#elif defined(__LINUX__)
iounmap((void*)offset);
#else
# warning "sdla_bus_space_unmap: Not supported yet!"
#endif
}
static __inline void
sdla_bus_set_region_1(sdlahw_t* hw, unsigned int offset, unsigned char val, unsigned int cnt)
{
#if defined(__FreeBSD__)
return;
#elif defined(__NetBSD__) || defined(__OpenBSD__)
bus_space_set_region_1(hw->hwcard->memt, hw->dpmbase, offset, val, cnt);
#elif defined(__LINUX__)
wp_memset_io(hw->dpmbase + offset, val, cnt);
#else
# warning "sdla_bus_set_region_1: Not supported yet!"
#endif
}
static __inline int
sdla_request_mem_region(sdlahw_t* hw, sdla_base_addr_t base_addr, unsigned int len, unsigned char* name, void** pres)
{
#if defined(__NetBSD__) || defined(__FreeBSD__) || defined(__OpenBSD__)
/* We don't need for BSD */
return 0;
#elif defined(__LINUX__)
void* resource;
if ((resource = request_mem_region(base_addr, len, name)) == NULL){
return -EINVAL;
}
*pres = resource;
return 0;
#else
# warning "sdla_request_mem_region: Not supported yet!"
return 0;
#endif
}
static __inline void
sdla_release_mem_region(sdlahw_t* hw, sdla_base_addr_t base_addr, unsigned int len)
{
#if defined(__NetBSD__) || defined(__FreeBSD__) || defined(__OpenBSD__)
return;
#elif defined(__LINUX__)
release_mem_region(base_addr, len);
#else
# warning "sdla_release_mem_region: Not supported yet!"
#endif
}
static __inline int
sdla_pci_enable_device(sdlahw_t* hw)
{
sdlahw_card_t* card;
WAN_ASSERT(hw == NULL);
WAN_ASSERT(hw->hwcard == NULL);
card = hw->hwcard;
#if defined(__NetBSD__) || defined(__FreeBSD__) || defined(__OpenBSD__)
return 0;
#elif defined(__LINUX__)
return pci_enable_device(card->pci_dev);
#else
# warning "sdla_release_mem_region: Not supported yet!"
return -EINVAL;
#endif
}
static __inline int
sdla_pci_disable_device(sdlahw_t* hw)
{
sdlahw_card_t* card;
WAN_ASSERT(hw == NULL);
WAN_ASSERT(hw->hwcard == NULL);
card = hw->hwcard;
#if defined(__NetBSD__) || defined(__FreeBSD__) || defined(__OpenBSD__)
return 0;
#elif defined(__LINUX__)
pci_disable_device(card->pci_dev);
return 0;
#else
# warning "sdla_release_mem_region: Not supported yet!"
return -EINVAL;
#endif
}
static __inline void
sdla_pci_set_master(sdlahw_t* hw)
{
sdlahw_card_t* card;
WAN_ASSERT1(hw == NULL);
WAN_ASSERT1(hw->hwcard == NULL);
card = hw->hwcard;
#if defined(__NetBSD__) || defined(__FreeBSD__) || defined(__OpenBSD__)
return;
#elif defined(__LINUX__)
pci_set_master(card->pci_dev);
#else
# warning "sdla_pci_set_master: Not supported yet!"
#endif
}
static __inline void
sdla_get_pci_base_resource_addr(sdlahw_t* hw, int pci_offset, sdla_base_addr_t *base_addr)
{
sdlahw_card_t* card;
WAN_ASSERT1(hw == NULL);
WAN_ASSERT1(hw->hwcard == NULL);
card = hw->hwcard;
#if defined(__FreeBSD__)
# if (__FreeBSD_version > 400000)
*base_addr = (sdla_base_addr_t)pci_read_config(card->pci_dev, pci_offset, 4);
# else
*base_addr = (sdla_base_addr_t)ci_cfgread(card->pci_dev, pci_offset, 4);
# endif
#elif defined(__NetBSD__) || defined(__OpenBSD__)
*base_addr = (sdla_base_addr_t)pci_conf_read(card->pci_dev->pa_pc, card->pci_dev->pa_tag, pci_offset);
#elif defined(__LINUX__)
if (pci_offset == PCI_IO_BASE_DWORD){
*base_addr = (sdla_base_addr_t)pci_resource_start(card->pci_dev,0);
}else{
*base_addr = (sdla_base_addr_t)pci_resource_start(card->pci_dev,1);
}
#else
# warning "sdla_get_pci_base_resource_addr: Not supported yet!"
#endif
}
#endif /* __SDLADRV__ */
#undef EXTERN
#endif /* _SDLADRV_H */