bcm4329/src/shared/siutils_priv.h - platform/hardware/broadcom/wlan - Git at Google

 /*
  * Include file private to the SOC Interconnect support files.
  *
  * Copyright (C) 1999-2009, Broadcom Corporation
  *
  *      Unless you and Broadcom execute a separate written software license
  * agreement governing use of this software, this software is licensed to you
  * under the terms of the GNU General Public License version 2 (the "GPL"),
  * available at http://www.broadcom.com/licenses/GPLv2.php, with the
  * following added to such license:
  *
  *      As a special exception, the copyright holders of this software give you
  * permission to link this software with independent modules, and to copy and
  * distribute the resulting executable under terms of your choice, provided that
  * you also meet, for each linked independent module, the terms and conditions of
  * the license of that module.  An independent module is a module which is not
  * derived from this software.  The special exception does not apply to any
  * modifications of the software.
  *
  *      Notwithstanding the above, under no circumstances may you combine this
  * software in any way with any other Broadcom software provided under a license
  * other than the GPL, without Broadcom's express prior written consent.
  *
  * $Id: siutils_priv.h,v 1.3.10.5.4.2 2009/09/22 13:28:16 Exp $
  */

 #ifndef	_siutils_priv_h_
 #define	_siutils_priv_h_

 /* debug/trace */
 #define	SI_ERROR(args)

 #define	SI_MSG(args)

 #define	IS_SIM(chippkg)	((chippkg == HDLSIM_PKG_ID) || (chippkg == HWSIM_PKG_ID))

 typedef uint32 (*si_intrsoff_t)(void *intr_arg);
 typedef void (*si_intrsrestore_t)(void *intr_arg, uint32 arg);
 typedef bool (*si_intrsenabled_t)(void *intr_arg);

 typedef struct gpioh_item {
 	void			*arg;
 	bool			level;
 	gpio_handler_t		handler;
 	uint32			event;
 	struct gpioh_item	*next;
 } gpioh_item_t;

 /* misc si info needed by some of the routines */
 typedef struct si_common_info {
 	void	*regs[SI_MAXCORES];	/* other regs va */
 	void	*regs2[SI_MAXCORES];	/* va of each core second register set (usbh20) */
 	uint	coreid[SI_MAXCORES];	/* id of each core */
 	uint32	cia[SI_MAXCORES];	/* erom cia entry for each core */
 	uint32	cib[SI_MAXCORES];	/* erom cia entry for each core */
 	uint32	coresba_size[SI_MAXCORES]; /* backplane address space size */
 	uint32	coresba2_size[SI_MAXCORES]; /* second address space size */
 	uint32	coresba[SI_MAXCORES];	/* backplane address of each core */
 	uint32	coresba2[SI_MAXCORES];	/* address of each core second register set (usbh20) */
 	void	*wrappers[SI_MAXCORES];	/* other cores wrapper va */
 	uint32	wrapba[SI_MAXCORES];	/* address of controlling wrapper */
 	uint32	oob_router;		/* oob router registers for axi */
 	uint8	attach_count;
 } si_common_info_t;

 typedef struct si_info {
 	struct si_pub pub;		/* back plane public state (must be first field) */

 	void	*osh;			/* osl os handle */
 	void	*sdh;			/* bcmsdh handle */
 	void *pch;			/* PCI/E core handle */
 	uint	dev_coreid;		/* the core provides driver functions */
 	void	*intr_arg;		/* interrupt callback function arg */
 	si_intrsoff_t intrsoff_fn;	/* turns chip interrupts off */
 	si_intrsrestore_t intrsrestore_fn; /* restore chip interrupts */
 	si_intrsenabled_t intrsenabled_fn; /* check if interrupts are enabled */


 	gpioh_item_t *gpioh_head; 	/* GPIO event handlers list */

 	bool	memseg;			/* flag to toggle MEM_SEG register */

 	char *vars;
 	uint varsz;

 	void	*curmap;		/* current regs va */

 	uint	curidx;			/* current core index */
 	uint	numcores;		/* # discovered cores */
 	void	*curwrap;		/* current wrapper va */
 	si_common_info_t	*common_info;	/* Common information for all the cores in a chip */
 } si_info_t;

 #define	SI_INFO(sih)	(si_info_t *)(uintptr)sih

 #define	GOODCOREADDR(x, b) (((x) >= (b)) && ((x) < ((b) + SI_MAXCORES * SI_CORE_SIZE)) && \
 		ISALIGNED((x), SI_CORE_SIZE))
 #define	GOODREGS(regs)	((regs) != NULL && ISALIGNED((uintptr)(regs), SI_CORE_SIZE))
 #define BADCOREADDR	0
 #define	GOODIDX(idx)	(((uint)idx) < SI_MAXCORES)
 #define	BADIDX		(SI_MAXCORES + 1)
 #define	NOREV		-1		/* Invalid rev */

 #define PCI(si)		((BUSTYPE((si)->pub.bustype) == PCI_BUS) &&	\
 			 ((si)->pub.buscoretype == PCI_CORE_ID))
 #define PCIE(si)	((BUSTYPE((si)->pub.bustype) == PCI_BUS) &&	\
 			 ((si)->pub.buscoretype == PCIE_CORE_ID))
 #define PCMCIA(si)	((BUSTYPE((si)->pub.bustype) == PCMCIA_BUS) && ((si)->memseg == TRUE))

 /* Newer chips can access PCI/PCIE and CC core without requiring to change
  * PCI BAR0 WIN
  */
 #define SI_FAST(si) (((si)->pub.buscoretype == PCIE_CORE_ID) ||	\
 		     (((si)->pub.buscoretype == PCI_CORE_ID) && (si)->pub.buscorerev >= 13))

 #define PCIEREGS(si) (((char *)((si)->curmap) + PCI_16KB0_PCIREGS_OFFSET))
 #define CCREGS_FAST(si) (((char *)((si)->curmap) + PCI_16KB0_CCREGS_OFFSET))

 /*
  * Macros to disable/restore function core(D11, ENET, ILINE20, etc) interrupts before/
  * after core switching to avoid invalid register accesss inside ISR.
  */
 #define INTR_OFF(si, intr_val) \
 	if ((si)->intrsoff_fn && (si)->common_info->coreid[(si)->curidx] == (si)->dev_coreid) {	\
 		intr_val = (*(si)->intrsoff_fn)((si)->intr_arg); }
 #define INTR_RESTORE(si, intr_val) \
 	if ((si)->intrsrestore_fn && (si)->common_info->coreid[(si)->curidx] == (si)->dev_coreid) {\
 		(*(si)->intrsrestore_fn)((si)->intr_arg, intr_val); }

 /* dynamic clock control defines */
 #define	LPOMINFREQ		25000		/* low power oscillator min */
 #define	LPOMAXFREQ		43000		/* low power oscillator max */
 #define	XTALMINFREQ		19800000	/* 20 MHz - 1% */
 #define	XTALMAXFREQ		20200000	/* 20 MHz + 1% */
 #define	PCIMINFREQ		25000000	/* 25 MHz */
 #define	PCIMAXFREQ		34000000	/* 33 MHz + fudge */

 #define	ILP_DIV_5MHZ		0		/* ILP = 5 MHz */
 #define	ILP_DIV_1MHZ		4		/* ILP = 1 MHz */

 #define PCI_FORCEHT(si)	\
 	(((PCIE(si)) && (si->pub.chip == BCM4311_CHIP_ID) && ((si->pub.chiprev <= 1))) || \
 	((PCI(si) || PCIE(si)) && (si->pub.chip == BCM4321_CHIP_ID)))

 /* GPIO Based LED powersave defines */
 #define DEFAULT_GPIO_ONTIME	10		/* Default: 10% on */
 #define DEFAULT_GPIO_OFFTIME	90		/* Default: 10% on */

 #ifndef DEFAULT_GPIOTIMERVAL
 #define DEFAULT_GPIOTIMERVAL  ((DEFAULT_GPIO_ONTIME << GPIO_ONTIME_SHIFT) | DEFAULT_GPIO_OFFTIME)
 #endif

 /* Silicon Backplane externs */
 extern void sb_scan(si_t *sih, void *regs, uint devid);
 extern uint sb_coreid(si_t *sih);
 extern uint sb_flag(si_t *sih);
 extern void sb_setint(si_t *sih, int siflag);
 extern uint sb_corevendor(si_t *sih);
 extern uint sb_corerev(si_t *sih);
 extern uint sb_corereg(si_t *sih, uint coreidx, uint regoff, uint mask, uint val);
 extern bool sb_iscoreup(si_t *sih);
 extern void *sb_setcoreidx(si_t *sih, uint coreidx);
 extern uint32 sb_core_cflags(si_t *sih, uint32 mask, uint32 val);
 extern void sb_core_cflags_wo(si_t *sih, uint32 mask, uint32 val);
 extern uint32 sb_core_sflags(si_t *sih, uint32 mask, uint32 val);
 extern void sb_commit(si_t *sih);
 extern uint32 sb_base(uint32 admatch);
 extern uint32 sb_size(uint32 admatch);
 extern void sb_core_reset(si_t *sih, uint32 bits, uint32 resetbits);
 extern void sb_core_tofixup(si_t *sih);
 extern void sb_core_disable(si_t *sih, uint32 bits);
 extern uint32 sb_addrspace(si_t *sih, uint asidx);
 extern uint32 sb_addrspacesize(si_t *sih, uint asidx);
 extern int sb_numaddrspaces(si_t *sih);

 extern uint32 sb_set_initiator_to(si_t *sih, uint32 to, uint idx);


 /* Wake-on-wireless-LAN (WOWL) */
 extern bool sb_pci_pmecap(si_t *sih);
 struct osl_info;
 extern bool sb_pci_fastpmecap(struct osl_info *osh);
 extern bool sb_pci_pmeclr(si_t *sih);
 extern void sb_pci_pmeen(si_t *sih);
 extern uint sb_pcie_readreg(void *sih, uint addrtype, uint offset);

 /* AMBA Interconnect exported externs */
 extern si_t *ai_attach(uint pcidev, osl_t *osh, void *regs, uint bustype,
                        void *sdh, char **vars, uint *varsz);
 extern si_t *ai_kattach(osl_t *osh);
 extern void ai_scan(si_t *sih, void *regs, uint devid);

 extern uint ai_flag(si_t *sih);
 extern void ai_setint(si_t *sih, int siflag);
 extern uint ai_coreidx(si_t *sih);
 extern uint ai_corevendor(si_t *sih);
 extern uint ai_corerev(si_t *sih);
 extern bool ai_iscoreup(si_t *sih);
 extern void *ai_setcoreidx(si_t *sih, uint coreidx);
 extern uint32 ai_core_cflags(si_t *sih, uint32 mask, uint32 val);
 extern void ai_core_cflags_wo(si_t *sih, uint32 mask, uint32 val);
 extern uint32 ai_core_sflags(si_t *sih, uint32 mask, uint32 val);
 extern uint ai_corereg(si_t *sih, uint coreidx, uint regoff, uint mask, uint val);
 extern void ai_core_reset(si_t *sih, uint32 bits, uint32 resetbits);
 extern void ai_core_disable(si_t *sih, uint32 bits);
 extern int ai_numaddrspaces(si_t *sih);
 extern uint32 ai_addrspace(si_t *sih, uint asidx);
 extern uint32 ai_addrspacesize(si_t *sih, uint asidx);
 extern void ai_write_wrap_reg(si_t *sih, uint32 offset, uint32 val);


 #endif	/* _siutils_priv_h_ */
	/*
	* Include file private to the SOC Interconnect support files.
	*
	* Copyright (C) 1999-2009, Broadcom Corporation
	*
	* Unless you and Broadcom execute a separate written software license
	* agreement governing use of this software, this software is licensed to you
	* under the terms of the GNU General Public License version 2 (the "GPL"),
	* available at http://www.broadcom.com/licenses/GPLv2.php, with the
	* following added to such license:
	*
	* As a special exception, the copyright holders of this software give you
	* permission to link this software with independent modules, and to copy and
	* distribute the resulting executable under terms of your choice, provided that
	* you also meet, for each linked independent module, the terms and conditions of
	* the license of that module. An independent module is a module which is not
	* derived from this software. The special exception does not apply to any
	* modifications of the software.
	*
	* Notwithstanding the above, under no circumstances may you combine this
	* software in any way with any other Broadcom software provided under a license
	* other than the GPL, without Broadcom's express prior written consent.
	*
	* $Id: siutils_priv.h,v 1.3.10.5.4.2 2009/09/22 13:28:16 Exp $
	*/

	#ifndef _siutils_priv_h_
	#define _siutils_priv_h_

	/* debug/trace */
	#define SI_ERROR(args)

	#define SI_MSG(args)

	#define IS_SIM(chippkg) ((chippkg == HDLSIM_PKG_ID) \|\| (chippkg == HWSIM_PKG_ID))

	typedef uint32 (si_intrsoff_t)(void intr_arg);
	typedef void (si_intrsrestore_t)(void intr_arg, uint32 arg);
	typedef bool (si_intrsenabled_t)(void intr_arg);

	typedef struct gpioh_item {
	void *arg;
	bool level;
	gpio_handler_t handler;
	uint32 event;
	struct gpioh_item *next;
	} gpioh_item_t;

	/* misc si info needed by some of the routines */
	typedef struct si_common_info {
	void regs[SI_MAXCORES]; / other regs va */
	void regs2[SI_MAXCORES]; / va of each core second register set (usbh20) */
	uint coreid[SI_MAXCORES]; /* id of each core */
	uint32 cia[SI_MAXCORES]; /* erom cia entry for each core */
	uint32 cib[SI_MAXCORES]; /* erom cia entry for each core */
	uint32 coresba_size[SI_MAXCORES]; /* backplane address space size */
	uint32 coresba2_size[SI_MAXCORES]; /* second address space size */
	uint32 coresba[SI_MAXCORES]; /* backplane address of each core */
	uint32 coresba2[SI_MAXCORES]; /* address of each core second register set (usbh20) */
	void wrappers[SI_MAXCORES]; / other cores wrapper va */
	uint32 wrapba[SI_MAXCORES]; /* address of controlling wrapper */
	uint32 oob_router; /* oob router registers for axi */
	uint8 attach_count;
	} si_common_info_t;

	typedef struct si_info {
	struct si_pub pub; /* back plane public state (must be first field) */

	void osh; / osl os handle */
	void sdh; / bcmsdh handle */
	void pch; / PCI/E core handle */
	uint dev_coreid; /* the core provides driver functions */
	void intr_arg; / interrupt callback function arg */
	si_intrsoff_t intrsoff_fn; /* turns chip interrupts off */
	si_intrsrestore_t intrsrestore_fn; /* restore chip interrupts */
	si_intrsenabled_t intrsenabled_fn; /* check if interrupts are enabled */


	gpioh_item_t gpioh_head; / GPIO event handlers list */

	bool memseg; /* flag to toggle MEM_SEG register */

	char *vars;
	uint varsz;

	void curmap; / current regs va */

	uint curidx; /* current core index */
	uint numcores; /* # discovered cores */
	void curwrap; / current wrapper va */
	si_common_info_t common_info; / Common information for all the cores in a chip */
	} si_info_t;

	#define SI_INFO(sih) (si_info_t *)(uintptr)sih

	#define GOODCOREADDR(x, b) (((x) >= (b)) && ((x) < ((b) + SI_MAXCORES * SI_CORE_SIZE)) && \
	ISALIGNED((x), SI_CORE_SIZE))
	#define GOODREGS(regs) ((regs) != NULL && ISALIGNED((uintptr)(regs), SI_CORE_SIZE))
	#define BADCOREADDR 0
	#define GOODIDX(idx) (((uint)idx) < SI_MAXCORES)
	#define BADIDX (SI_MAXCORES + 1)
	#define NOREV -1 /* Invalid rev */

	#define PCI(si) ((BUSTYPE((si)->pub.bustype) == PCI_BUS) && \
	((si)->pub.buscoretype == PCI_CORE_ID))
	#define PCIE(si) ((BUSTYPE((si)->pub.bustype) == PCI_BUS) && \
	((si)->pub.buscoretype == PCIE_CORE_ID))
	#define PCMCIA(si) ((BUSTYPE((si)->pub.bustype) == PCMCIA_BUS) && ((si)->memseg == TRUE))

	/* Newer chips can access PCI/PCIE and CC core without requiring to change
	* PCI BAR0 WIN
	*/
	#define SI_FAST(si) (((si)->pub.buscoretype == PCIE_CORE_ID) \|\| \
	(((si)->pub.buscoretype == PCI_CORE_ID) && (si)->pub.buscorerev >= 13))

	#define PCIEREGS(si) (((char *)((si)->curmap) + PCI_16KB0_PCIREGS_OFFSET))
	#define CCREGS_FAST(si) (((char *)((si)->curmap) + PCI_16KB0_CCREGS_OFFSET))

	/*
	* Macros to disable/restore function core(D11, ENET, ILINE20, etc) interrupts before/
	* after core switching to avoid invalid register accesss inside ISR.
	*/
	#define INTR_OFF(si, intr_val) \
	if ((si)->intrsoff_fn && (si)->common_info->coreid[(si)->curidx] == (si)->dev_coreid) { \
	intr_val = (*(si)->intrsoff_fn)((si)->intr_arg); }
	#define INTR_RESTORE(si, intr_val) \
	if ((si)->intrsrestore_fn && (si)->common_info->coreid[(si)->curidx] == (si)->dev_coreid) {\
	(*(si)->intrsrestore_fn)((si)->intr_arg, intr_val); }

	/* dynamic clock control defines */
	#define LPOMINFREQ 25000 /* low power oscillator min */
	#define LPOMAXFREQ 43000 /* low power oscillator max */
	#define XTALMINFREQ 19800000 /* 20 MHz - 1% */
	#define XTALMAXFREQ 20200000 /* 20 MHz + 1% */
	#define PCIMINFREQ 25000000 /* 25 MHz */
	#define PCIMAXFREQ 34000000 /* 33 MHz + fudge */

	#define ILP_DIV_5MHZ 0 /* ILP = 5 MHz */
	#define ILP_DIV_1MHZ 4 /* ILP = 1 MHz */

	#define PCI_FORCEHT(si) \
	(((PCIE(si)) && (si->pub.chip == BCM4311_CHIP_ID) && ((si->pub.chiprev <= 1))) \|\| \
	((PCI(si) \|\| PCIE(si)) && (si->pub.chip == BCM4321_CHIP_ID)))

	/* GPIO Based LED powersave defines */
	#define DEFAULT_GPIO_ONTIME 10 /* Default: 10% on */
	#define DEFAULT_GPIO_OFFTIME 90 /* Default: 10% on */

	#ifndef DEFAULT_GPIOTIMERVAL
	#define DEFAULT_GPIOTIMERVAL ((DEFAULT_GPIO_ONTIME << GPIO_ONTIME_SHIFT) \| DEFAULT_GPIO_OFFTIME)
	#endif

	/* Silicon Backplane externs */
	extern void sb_scan(si_t sih, void regs, uint devid);
	extern uint sb_coreid(si_t *sih);
	extern uint sb_flag(si_t *sih);
	extern void sb_setint(si_t *sih, int siflag);
	extern uint sb_corevendor(si_t *sih);
	extern uint sb_corerev(si_t *sih);
	extern uint sb_corereg(si_t *sih, uint coreidx, uint regoff, uint mask, uint val);
	extern bool sb_iscoreup(si_t *sih);
	extern void sb_setcoreidx(si_t sih, uint coreidx);
	extern uint32 sb_core_cflags(si_t *sih, uint32 mask, uint32 val);
	extern void sb_core_cflags_wo(si_t *sih, uint32 mask, uint32 val);
	extern uint32 sb_core_sflags(si_t *sih, uint32 mask, uint32 val);
	extern void sb_commit(si_t *sih);
	extern uint32 sb_base(uint32 admatch);
	extern uint32 sb_size(uint32 admatch);
	extern void sb_core_reset(si_t *sih, uint32 bits, uint32 resetbits);
	extern void sb_core_tofixup(si_t *sih);
	extern void sb_core_disable(si_t *sih, uint32 bits);
	extern uint32 sb_addrspace(si_t *sih, uint asidx);
	extern uint32 sb_addrspacesize(si_t *sih, uint asidx);
	extern int sb_numaddrspaces(si_t *sih);

	extern uint32 sb_set_initiator_to(si_t *sih, uint32 to, uint idx);



	/* Wake-on-wireless-LAN (WOWL) */
	extern bool sb_pci_pmecap(si_t *sih);
	struct osl_info;
	extern bool sb_pci_fastpmecap(struct osl_info *osh);
	extern bool sb_pci_pmeclr(si_t *sih);
	extern void sb_pci_pmeen(si_t *sih);
	extern uint sb_pcie_readreg(void *sih, uint addrtype, uint offset);

	/* AMBA Interconnect exported externs */
	extern si_t ai_attach(uint pcidev, osl_t osh, void *regs, uint bustype,
	void sdh, char vars, uint varsz);
	extern si_t ai_kattach(osl_t osh);
	extern void ai_scan(si_t sih, void regs, uint devid);

	extern uint ai_flag(si_t *sih);
	extern void ai_setint(si_t *sih, int siflag);
	extern uint ai_coreidx(si_t *sih);
	extern uint ai_corevendor(si_t *sih);
	extern uint ai_corerev(si_t *sih);
	extern bool ai_iscoreup(si_t *sih);
	extern void ai_setcoreidx(si_t sih, uint coreidx);
	extern uint32 ai_core_cflags(si_t *sih, uint32 mask, uint32 val);
	extern void ai_core_cflags_wo(si_t *sih, uint32 mask, uint32 val);
	extern uint32 ai_core_sflags(si_t *sih, uint32 mask, uint32 val);
	extern uint ai_corereg(si_t *sih, uint coreidx, uint regoff, uint mask, uint val);
	extern void ai_core_reset(si_t *sih, uint32 bits, uint32 resetbits);
	extern void ai_core_disable(si_t *sih, uint32 bits);
	extern int ai_numaddrspaces(si_t *sih);
	extern uint32 ai_addrspace(si_t *sih, uint asidx);
	extern uint32 ai_addrspacesize(si_t *sih, uint asidx);
	extern void ai_write_wrap_reg(si_t *sih, uint32 offset, uint32 val);


	#endif /* _siutils_priv_h_ */