bcmsdh_linux.c - third_party/bcmdhd - Git at Google

 /*
  * SDIO access interface for drivers - linux specific (pci only)
  *
  * Copyright 1999-2016, Broadcom Corporation
  * 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.
  *
  * This software is provided by the copyright holder "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 copyright holder 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
  *
  *
  * <<Broadcom-WL-IPTag/Open:>>
  *
  * $Id: bcmsdh_linux.c 514727 2014-11-12 03:02:48Z $
  */

 /**
  * @file bcmsdh_linux.c
  */

 #define __UNDEF_NO_VERSION__

 #include <typedefs.h>
 #include <linuxver.h>
 #include <linux/pci.h>
 #include <linux/completion.h>

 #include <osl.h>
 #include <pcicfg.h>
 #include <bcmdefs.h>
 #include <bcmdevs.h>
 #include <linux/irq.h>
 extern void dhdsdio_isr(void * args);
 #include <bcmutils.h>
 #include <dngl_stats.h>
 #include <dhd.h>
 #if defined(CONFIG_ARCH_ODIN)
 #include <linux/platform_data/gpio-odin.h>
 #endif /* defined(CONFIG_ARCH_ODIN) */
 #include <dhd_linux.h>

 /* driver info, initialized when bcmsdh_register is called */
 static bcmsdh_driver_t drvinfo = {NULL, NULL, NULL, NULL};

 typedef enum {
 	DHD_INTR_INVALID = 0,
 	DHD_INTR_INBAND,
 	DHD_INTR_HWOOB,
 	DHD_INTR_SWOOB
 } DHD_HOST_INTR_TYPE;

 /* the BCMSDH module comprises the generic part (bcmsdh.c) and OS specific layer (e.g.
  * bcmsdh_linux.c). Put all OS specific variables (e.g. irq number and flags) here rather
  * than in the common structure bcmsdh_info. bcmsdh_info only keeps a handle (os_ctx) to this
  * structure.
  */
 typedef struct bcmsdh_os_info {
 	DHD_HOST_INTR_TYPE	intr_type;
 	int			oob_irq_num;	/* valid when hardware or software oob in use */
 	unsigned long		oob_irq_flags;	/* valid when hardware or software oob in use */
 	bool			oob_irq_registered;
 	bool			oob_irq_enabled;
 	bool			oob_irq_wake_enabled;
 	spinlock_t		oob_irq_spinlock;
 	bcmsdh_cb_fn_t		oob_irq_handler;
 	void			*oob_irq_handler_context;
 	void			*context;	/* context returned from upper layer */
 	void			*sdioh;		/* handle to lower layer (sdioh) */
 	void			*dev;		/* handle to the underlying device */
 	bool			dev_wake_enabled;
 } bcmsdh_os_info_t;

 /* debugging macros */
 #define SDLX_MSG(x)

 /**
  * Checks to see if vendor and device IDs match a supported SDIO Host Controller.
  */
 bool
 bcmsdh_chipmatch(uint16 vendor, uint16 device)
 {
 	/* Add other vendors and devices as required */

 #ifdef BCMSDIOH_STD
 	/* Check for Arasan host controller */
 	if (vendor == VENDOR_SI_IMAGE) {
 		return (TRUE);
 	}
 	/* Check for BRCM 27XX Standard host controller */
 	if (device == BCM27XX_SDIOH_ID && vendor == VENDOR_BROADCOM) {
 		return (TRUE);
 	}
 	/* Check for BRCM Standard host controller */
 	if (device == SDIOH_FPGA_ID && vendor == VENDOR_BROADCOM) {
 		return (TRUE);
 	}
 	/* Check for TI PCIxx21 Standard host controller */
 	if (device == PCIXX21_SDIOH_ID && vendor == VENDOR_TI) {
 		return (TRUE);
 	}
 	if (device == PCIXX21_SDIOH0_ID && vendor == VENDOR_TI) {
 		return (TRUE);
 	}
 	/* Ricoh R5C822 Standard SDIO Host */
 	if (device == R5C822_SDIOH_ID && vendor == VENDOR_RICOH) {
 		return (TRUE);
 	}
 	/* JMicron Standard SDIO Host */
 	if (device == JMICRON_SDIOH_ID && vendor == VENDOR_JMICRON) {
 		return (TRUE);
 	}

 #endif /* BCMSDIOH_STD */
 #ifdef BCMSDIOH_SPI
 	/* This is the PciSpiHost. */
 	if (device == SPIH_FPGA_ID && vendor == VENDOR_BROADCOM) {
 		printf("Found PCI SPI Host Controller\n");
 		return (TRUE);
 	}

 #endif /* BCMSDIOH_SPI */

 	return (FALSE);
 }

 void* bcmsdh_probe(osl_t *osh, void *dev, void *sdioh, void *adapter_info, uint bus_type,
 	uint bus_num, uint slot_num)
 {
 	ulong regs;
 	bcmsdh_info_t *bcmsdh;
 	uint32 vendevid;
 	bcmsdh_os_info_t *bcmsdh_osinfo = NULL;

 	bcmsdh = bcmsdh_attach(osh, sdioh, &regs);
 	if (bcmsdh == NULL) {
 		SDLX_MSG(("%s: bcmsdh_attach failed\n", __FUNCTION__));
 		goto err;
 	}
 	bcmsdh_osinfo = MALLOC(osh, sizeof(bcmsdh_os_info_t));
 	if (bcmsdh_osinfo == NULL) {
 		SDLX_MSG(("%s: failed to allocate bcmsdh_os_info_t\n", __FUNCTION__));
 		goto err;
 	}
 	bzero((char *)bcmsdh_osinfo, sizeof(bcmsdh_os_info_t));
 	bcmsdh->os_cxt = bcmsdh_osinfo;
 	bcmsdh_osinfo->sdioh = sdioh;
 	bcmsdh_osinfo->dev = dev;
 	osl_set_bus_handle(osh, bcmsdh);

 #if !defined(CONFIG_HAS_WAKELOCK) && (LINUX_VERSION_CODE > KERNEL_VERSION(2, 6, 36))
 	if (dev && device_init_wakeup(dev, true) == 0)
 		bcmsdh_osinfo->dev_wake_enabled = TRUE;
 #endif /* !defined(CONFIG_HAS_WAKELOCK) && (LINUX_VERSION_CODE > KERNEL_VERSION(2, 6, 36)) */

 #if defined(OOB_INTR_ONLY)
 	spin_lock_init(&bcmsdh_osinfo->oob_irq_spinlock);
 	/* Get customer specific OOB IRQ parametres: IRQ number as IRQ type */
 	bcmsdh_osinfo->oob_irq_num = wifi_platform_get_irq_number(adapter_info,
 		&bcmsdh_osinfo->oob_irq_flags);
 	if  (bcmsdh_osinfo->oob_irq_num < 0) {
 		SDLX_MSG(("%s: Host OOB irq is not defined\n", __FUNCTION__));
 		goto err;
 	}
 #endif /* defined(BCMLXSDMMC) */

 	/* Read the vendor/device ID from the CIS */
 	vendevid = bcmsdh_query_device(bcmsdh);
 	/* try to attach to the target device */
 	bcmsdh_osinfo->context = drvinfo.probe((vendevid >> 16), (vendevid & 0xFFFF), bus_num,
 		slot_num, 0, bus_type, (void *)regs, osh, bcmsdh);
 	if (bcmsdh_osinfo->context == NULL) {
 		SDLX_MSG(("%s: device attach failed\n", __FUNCTION__));
 		goto err;
 	}

 	return bcmsdh;

 	/* error handling */
 err:
 	if (bcmsdh != NULL)
 		bcmsdh_detach(osh, bcmsdh);
 	if (bcmsdh_osinfo != NULL)
 		MFREE(osh, bcmsdh_osinfo, sizeof(bcmsdh_os_info_t));
 	return NULL;
 }

 int bcmsdh_remove(bcmsdh_info_t *bcmsdh)
 {
 	bcmsdh_os_info_t *bcmsdh_osinfo = bcmsdh->os_cxt;

 #if !defined(CONFIG_HAS_WAKELOCK) && (LINUX_VERSION_CODE > KERNEL_VERSION(2, 6, 36))
 	if (bcmsdh_osinfo->dev)
 		device_init_wakeup(bcmsdh_osinfo->dev, false);
 	bcmsdh_osinfo->dev_wake_enabled = FALSE;
 #endif /* !defined(CONFIG_HAS_WAKELOCK) && (LINUX_VERSION_CODE > KERNEL_VERSION(2, 6, 36)) */

 	drvinfo.remove(bcmsdh_osinfo->context);
 	MFREE(bcmsdh->osh, bcmsdh->os_cxt, sizeof(bcmsdh_os_info_t));
 	bcmsdh_detach(bcmsdh->osh, bcmsdh);

 	return 0;
 }

 int bcmsdh_suspend(bcmsdh_info_t *bcmsdh)
 {
 	bcmsdh_os_info_t *bcmsdh_osinfo = bcmsdh->os_cxt;

 	if (drvinfo.suspend && drvinfo.suspend(bcmsdh_osinfo->context))
 		return -EBUSY;
 	return 0;
 }

 int bcmsdh_resume(bcmsdh_info_t *bcmsdh)
 {
 	bcmsdh_os_info_t *bcmsdh_osinfo = bcmsdh->os_cxt;

 	if (drvinfo.resume)
 		return drvinfo.resume(bcmsdh_osinfo->context);
 	return 0;
 }

 extern int bcmsdh_register_client_driver(void);
 extern void bcmsdh_unregister_client_driver(void);
 extern int sdio_func_reg_notify(void* semaphore);
 extern void sdio_func_unreg_notify(void);

 #if defined(BCMLXSDMMC)
 int bcmsdh_reg_sdio_notify(void* semaphore)
 {
 	return sdio_func_reg_notify(semaphore);
 }

 void bcmsdh_unreg_sdio_notify(void)
 {
 	sdio_func_unreg_notify();
 }
 #endif /* defined(BCMLXSDMMC) */

 int
 bcmsdh_register(bcmsdh_driver_t *driver)
 {
 	int error = 0;

 	drvinfo = *driver;
 	SDLX_MSG(("%s: register client driver\n", __FUNCTION__));
 	error = bcmsdh_register_client_driver();
 	if (error)
 		SDLX_MSG(("%s: failed %d\n", __FUNCTION__, error));

 	return error;
 }

 void
 bcmsdh_unregister(void)
 {
 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 0))
 		if (bcmsdh_pci_driver.node.next == NULL)
 			return;
 #endif

 	bcmsdh_unregister_client_driver();
 }

 void bcmsdh_dev_pm_stay_awake(bcmsdh_info_t *bcmsdh)
 {
 #if !defined(CONFIG_HAS_WAKELOCK) && (LINUX_VERSION_CODE > KERNEL_VERSION(2, 6, 36))
 	bcmsdh_os_info_t *bcmsdh_osinfo = bcmsdh->os_cxt;
 	pm_stay_awake(bcmsdh_osinfo->dev);
 #endif /* !defined(CONFIG_HAS_WAKELOCK) && (LINUX_VERSION_CODE > KERNEL_VERSION(2, 6, 36)) */
 }

 void bcmsdh_dev_relax(bcmsdh_info_t *bcmsdh)
 {
 #if !defined(CONFIG_HAS_WAKELOCK) && (LINUX_VERSION_CODE > KERNEL_VERSION(2, 6, 36))
 	bcmsdh_os_info_t *bcmsdh_osinfo = bcmsdh->os_cxt;
 	pm_relax(bcmsdh_osinfo->dev);
 #endif /* !defined(CONFIG_HAS_WAKELOCK) && (LINUX_VERSION_CODE > KERNEL_VERSION(2, 6, 36)) */
 }

 bool bcmsdh_dev_pm_enabled(bcmsdh_info_t *bcmsdh)
 {
 	bcmsdh_os_info_t *bcmsdh_osinfo = bcmsdh->os_cxt;

 	return bcmsdh_osinfo->dev_wake_enabled;
 }

 #if defined(OOB_INTR_ONLY)
 void bcmsdh_oob_intr_set(bcmsdh_info_t *bcmsdh, bool enable)
 {
 	unsigned long flags;
 	bcmsdh_os_info_t *bcmsdh_osinfo;

 	if (!bcmsdh)
 		return;

 	bcmsdh_osinfo = bcmsdh->os_cxt;
 	spin_lock_irqsave(&bcmsdh_osinfo->oob_irq_spinlock, flags);
 	if (bcmsdh_osinfo->oob_irq_enabled != enable) {
 		if (enable)
 			enable_irq(bcmsdh_osinfo->oob_irq_num);
 		else
 			disable_irq_nosync(bcmsdh_osinfo->oob_irq_num);
 		bcmsdh_osinfo->oob_irq_enabled = enable;
 	}
 	spin_unlock_irqrestore(&bcmsdh_osinfo->oob_irq_spinlock, flags);
 }

 static irqreturn_t wlan_oob_irq(int irq, void *dev_id)
 {
 	bcmsdh_info_t *bcmsdh = (bcmsdh_info_t *)dev_id;
 	bcmsdh_os_info_t *bcmsdh_osinfo = bcmsdh->os_cxt;

 	bcmsdh_oob_intr_set(bcmsdh, FALSE);
 	bcmsdh_osinfo->oob_irq_handler(bcmsdh_osinfo->oob_irq_handler_context);

 	return IRQ_HANDLED;
 }

 int bcmsdh_oob_intr_register(bcmsdh_info_t *bcmsdh, bcmsdh_cb_fn_t oob_irq_handler,
 	void* oob_irq_handler_context)
 {
 	int err = 0;
 	bcmsdh_os_info_t *bcmsdh_osinfo = bcmsdh->os_cxt;

 	SDLX_MSG(("%s: Enter\n", __FUNCTION__));
 	if (bcmsdh_osinfo->oob_irq_registered) {
 		SDLX_MSG(("%s: irq is already registered\n", __FUNCTION__));
 		return -EBUSY;
 	}
 #ifdef HW_OOB
 	printf("%s: HW_OOB enabled\n", __FUNCTION__);
 #else
 	printf("%s: SW_OOB enabled\n", __FUNCTION__);
 #endif
 	SDLX_MSG(("%s OOB irq=%d flags=0x%X\n", __FUNCTION__,
 		(int)bcmsdh_osinfo->oob_irq_num, (int)bcmsdh_osinfo->oob_irq_flags));
 	bcmsdh_osinfo->oob_irq_handler = oob_irq_handler;
 	bcmsdh_osinfo->oob_irq_handler_context = oob_irq_handler_context;
 	bcmsdh_osinfo->oob_irq_enabled = TRUE;
 	bcmsdh_osinfo->oob_irq_registered = TRUE;
 #if defined(CONFIG_ARCH_ODIN)
 	err = odin_gpio_sms_request_irq(bcmsdh_osinfo->oob_irq_num, wlan_oob_irq,
 		bcmsdh_osinfo->oob_irq_flags, "bcmsdh_sdmmc", bcmsdh);
 #else
 	err = request_irq(bcmsdh_osinfo->oob_irq_num, wlan_oob_irq,
 		bcmsdh_osinfo->oob_irq_flags, "bcmsdh_sdmmc", bcmsdh);
 #endif /* defined(CONFIG_ARCH_ODIN) */
 	if (err) {
 		bcmsdh_osinfo->oob_irq_enabled = FALSE;
 		bcmsdh_osinfo->oob_irq_registered = FALSE;
 		SDLX_MSG(("%s: request_irq failed with %d\n", __FUNCTION__, err));
 		return err;
 	}

 #if defined(DISABLE_WOWLAN)
 	SDLX_MSG(("%s: disable_irq_wake\n", __FUNCTION__));
 	bcmsdh_osinfo->oob_irq_wake_enabled = FALSE;
 #else
 	SDLX_MSG(("%s: enable_irq_wake\n", __FUNCTION__));
 	err = enable_irq_wake(bcmsdh_osinfo->oob_irq_num);
 	if (err)
 		SDLX_MSG(("%s: enable_irq_wake failed with %d\n", __FUNCTION__, err));
 	else
 		bcmsdh_osinfo->oob_irq_wake_enabled = TRUE;
 #endif

 	return 0;
 }

 void bcmsdh_oob_intr_unregister(bcmsdh_info_t *bcmsdh)
 {
 	int err = 0;
 	bcmsdh_os_info_t *bcmsdh_osinfo = bcmsdh->os_cxt;

 	SDLX_MSG(("%s: Enter\n", __FUNCTION__));
 	if (!bcmsdh_osinfo->oob_irq_registered) {
 		SDLX_MSG(("%s: irq is not registered\n", __FUNCTION__));
 		return;
 	}
 	if (bcmsdh_osinfo->oob_irq_wake_enabled) {
 		err = disable_irq_wake(bcmsdh_osinfo->oob_irq_num);
 		if (!err)
 			bcmsdh_osinfo->oob_irq_wake_enabled = FALSE;
 	}
 	if (bcmsdh_osinfo->oob_irq_enabled) {
 		disable_irq(bcmsdh_osinfo->oob_irq_num);
 		bcmsdh_osinfo->oob_irq_enabled = FALSE;
 	}
 	free_irq(bcmsdh_osinfo->oob_irq_num, bcmsdh);
 	bcmsdh_osinfo->oob_irq_registered = FALSE;
 }
 #endif

 /* Module parameters specific to each host-controller driver */

 extern uint sd_msglevel;	/* Debug message level */
 module_param(sd_msglevel, uint, 0);

 extern uint sd_power;	/* 0 = SD Power OFF, 1 = SD Power ON. */
 module_param(sd_power, uint, 0);

 extern uint sd_clock;	/* SD Clock Control, 0 = SD Clock OFF, 1 = SD Clock ON */
 module_param(sd_clock, uint, 0);

 extern uint sd_divisor;	/* Divisor (-1 means external clock) */
 module_param(sd_divisor, uint, 0);

 extern uint sd_sdmode;	/* Default is SD4, 0=SPI, 1=SD1, 2=SD4 */
 module_param(sd_sdmode, uint, 0);

 extern uint sd_hiok;	/* Ok to use hi-speed mode */
 module_param(sd_hiok, uint, 0);

 extern uint sd_f2_blocksize;
 module_param(sd_f2_blocksize, int, 0);

 #ifdef BCMSDIOH_STD
 extern int sd_uhsimode;
 module_param(sd_uhsimode, int, 0);
 extern uint sd_tuning_period;
 module_param(sd_tuning_period, uint, 0);
 extern int sd_delay_value;
 module_param(sd_delay_value, uint, 0);

 /* SDIO Drive Strength for UHSI mode specific to SDIO3.0 */
 extern char dhd_sdiod_uhsi_ds_override[2];
 module_param_string(dhd_sdiod_uhsi_ds_override, dhd_sdiod_uhsi_ds_override, 2, 0);

 #endif

 #ifdef BCMSDH_MODULE
 EXPORT_SYMBOL(bcmsdh_attach);
 EXPORT_SYMBOL(bcmsdh_detach);
 EXPORT_SYMBOL(bcmsdh_intr_query);
 EXPORT_SYMBOL(bcmsdh_intr_enable);
 EXPORT_SYMBOL(bcmsdh_intr_disable);
 EXPORT_SYMBOL(bcmsdh_intr_reg);
 EXPORT_SYMBOL(bcmsdh_intr_dereg);

 #if defined(DHD_DEBUG)
 EXPORT_SYMBOL(bcmsdh_intr_pending);
 #endif

 EXPORT_SYMBOL(bcmsdh_devremove_reg);
 EXPORT_SYMBOL(bcmsdh_cfg_read);
 EXPORT_SYMBOL(bcmsdh_cfg_write);
 EXPORT_SYMBOL(bcmsdh_cis_read);
 EXPORT_SYMBOL(bcmsdh_reg_read);
 EXPORT_SYMBOL(bcmsdh_reg_write);
 EXPORT_SYMBOL(bcmsdh_regfail);
 EXPORT_SYMBOL(bcmsdh_send_buf);
 EXPORT_SYMBOL(bcmsdh_recv_buf);

 EXPORT_SYMBOL(bcmsdh_rwdata);
 EXPORT_SYMBOL(bcmsdh_abort);
 EXPORT_SYMBOL(bcmsdh_query_device);
 EXPORT_SYMBOL(bcmsdh_query_iofnum);
 EXPORT_SYMBOL(bcmsdh_iovar_op);
 EXPORT_SYMBOL(bcmsdh_register);
 EXPORT_SYMBOL(bcmsdh_unregister);
 EXPORT_SYMBOL(bcmsdh_chipmatch);
 EXPORT_SYMBOL(bcmsdh_reset);
 EXPORT_SYMBOL(bcmsdh_waitlockfree);

 EXPORT_SYMBOL(bcmsdh_get_dstatus);
 EXPORT_SYMBOL(bcmsdh_cfg_read_word);
 EXPORT_SYMBOL(bcmsdh_cfg_write_word);
 EXPORT_SYMBOL(bcmsdh_cur_sbwad);
 EXPORT_SYMBOL(bcmsdh_chipinfo);

 #endif /* BCMSDH_MODULE */
	/*
	* SDIO access interface for drivers - linux specific (pci only)
	*
	* Copyright 1999-2016, Broadcom Corporation
	* 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.
	*
	* This software is provided by the copyright holder "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 copyright holder 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
	*
	*
	* <<Broadcom-WL-IPTag/Open:>>
	*
	* $Id: bcmsdh_linux.c 514727 2014-11-12 03:02:48Z $
	*/

	/**
	* @file bcmsdh_linux.c
	*/

	#define __UNDEF_NO_VERSION__

	#include <typedefs.h>
	#include <linuxver.h>
	#include <linux/pci.h>
	#include <linux/completion.h>

	#include <osl.h>
	#include <pcicfg.h>
	#include <bcmdefs.h>
	#include <bcmdevs.h>
	#include <linux/irq.h>
	extern void dhdsdio_isr(void * args);
	#include <bcmutils.h>
	#include <dngl_stats.h>
	#include <dhd.h>
	#if defined(CONFIG_ARCH_ODIN)
	#include <linux/platform_data/gpio-odin.h>
	#endif /* defined(CONFIG_ARCH_ODIN) */
	#include <dhd_linux.h>

	/* driver info, initialized when bcmsdh_register is called */
	static bcmsdh_driver_t drvinfo = {NULL, NULL, NULL, NULL};

	typedef enum {
	DHD_INTR_INVALID = 0,
	DHD_INTR_INBAND,
	DHD_INTR_HWOOB,
	DHD_INTR_SWOOB
	} DHD_HOST_INTR_TYPE;

	/* the BCMSDH module comprises the generic part (bcmsdh.c) and OS specific layer (e.g.
	* bcmsdh_linux.c). Put all OS specific variables (e.g. irq number and flags) here rather
	* than in the common structure bcmsdh_info. bcmsdh_info only keeps a handle (os_ctx) to this
	* structure.
	*/
	typedef struct bcmsdh_os_info {
	DHD_HOST_INTR_TYPE intr_type;
	int oob_irq_num; /* valid when hardware or software oob in use */
	unsigned long oob_irq_flags; /* valid when hardware or software oob in use */
	bool oob_irq_registered;
	bool oob_irq_enabled;
	bool oob_irq_wake_enabled;
	spinlock_t oob_irq_spinlock;
	bcmsdh_cb_fn_t oob_irq_handler;
	void *oob_irq_handler_context;
	void context; / context returned from upper layer */
	void sdioh; / handle to lower layer (sdioh) */
	void dev; / handle to the underlying device */
	bool dev_wake_enabled;
	} bcmsdh_os_info_t;

	/* debugging macros */
	#define SDLX_MSG(x)

	/**
	* Checks to see if vendor and device IDs match a supported SDIO Host Controller.
	*/
	bool
	bcmsdh_chipmatch(uint16 vendor, uint16 device)
	{
	/* Add other vendors and devices as required */

	#ifdef BCMSDIOH_STD
	/* Check for Arasan host controller */
	if (vendor == VENDOR_SI_IMAGE) {
	return (TRUE);
	}
	/* Check for BRCM 27XX Standard host controller */
	if (device == BCM27XX_SDIOH_ID && vendor == VENDOR_BROADCOM) {
	return (TRUE);
	}
	/* Check for BRCM Standard host controller */
	if (device == SDIOH_FPGA_ID && vendor == VENDOR_BROADCOM) {
	return (TRUE);
	}
	/* Check for TI PCIxx21 Standard host controller */
	if (device == PCIXX21_SDIOH_ID && vendor == VENDOR_TI) {
	return (TRUE);
	}
	if (device == PCIXX21_SDIOH0_ID && vendor == VENDOR_TI) {
	return (TRUE);
	}
	/* Ricoh R5C822 Standard SDIO Host */
	if (device == R5C822_SDIOH_ID && vendor == VENDOR_RICOH) {
	return (TRUE);
	}
	/* JMicron Standard SDIO Host */
	if (device == JMICRON_SDIOH_ID && vendor == VENDOR_JMICRON) {
	return (TRUE);
	}

	#endif /* BCMSDIOH_STD */
	#ifdef BCMSDIOH_SPI
	/* This is the PciSpiHost. */
	if (device == SPIH_FPGA_ID && vendor == VENDOR_BROADCOM) {
	printf("Found PCI SPI Host Controller\n");
	return (TRUE);
	}

	#endif /* BCMSDIOH_SPI */

	return (FALSE);
	}

	void* bcmsdh_probe(osl_t osh, void dev, void sdioh, void adapter_info, uint bus_type,
	uint bus_num, uint slot_num)
	{
	ulong regs;
	bcmsdh_info_t *bcmsdh;
	uint32 vendevid;
	bcmsdh_os_info_t *bcmsdh_osinfo = NULL;

	bcmsdh = bcmsdh_attach(osh, sdioh, &regs);
	if (bcmsdh == NULL) {
	SDLX_MSG(("%s: bcmsdh_attach failed\n", __FUNCTION__));
	goto err;
	}
	bcmsdh_osinfo = MALLOC(osh, sizeof(bcmsdh_os_info_t));
	if (bcmsdh_osinfo == NULL) {
	SDLX_MSG(("%s: failed to allocate bcmsdh_os_info_t\n", __FUNCTION__));
	goto err;
	}
	bzero((char *)bcmsdh_osinfo, sizeof(bcmsdh_os_info_t));
	bcmsdh->os_cxt = bcmsdh_osinfo;
	bcmsdh_osinfo->sdioh = sdioh;
	bcmsdh_osinfo->dev = dev;
	osl_set_bus_handle(osh, bcmsdh);

	#if !defined(CONFIG_HAS_WAKELOCK) && (LINUX_VERSION_CODE > KERNEL_VERSION(2, 6, 36))
	if (dev && device_init_wakeup(dev, true) == 0)
	bcmsdh_osinfo->dev_wake_enabled = TRUE;
	#endif /* !defined(CONFIG_HAS_WAKELOCK) && (LINUX_VERSION_CODE > KERNEL_VERSION(2, 6, 36)) */

	#if defined(OOB_INTR_ONLY)
	spin_lock_init(&bcmsdh_osinfo->oob_irq_spinlock);
	/* Get customer specific OOB IRQ parametres: IRQ number as IRQ type */
	bcmsdh_osinfo->oob_irq_num = wifi_platform_get_irq_number(adapter_info,
	&bcmsdh_osinfo->oob_irq_flags);
	if (bcmsdh_osinfo->oob_irq_num < 0) {
	SDLX_MSG(("%s: Host OOB irq is not defined\n", __FUNCTION__));
	goto err;
	}
	#endif /* defined(BCMLXSDMMC) */

	/* Read the vendor/device ID from the CIS */
	vendevid = bcmsdh_query_device(bcmsdh);
	/* try to attach to the target device */
	bcmsdh_osinfo->context = drvinfo.probe((vendevid >> 16), (vendevid & 0xFFFF), bus_num,
	slot_num, 0, bus_type, (void *)regs, osh, bcmsdh);
	if (bcmsdh_osinfo->context == NULL) {
	SDLX_MSG(("%s: device attach failed\n", __FUNCTION__));
	goto err;
	}

	return bcmsdh;

	/* error handling */
	err:
	if (bcmsdh != NULL)
	bcmsdh_detach(osh, bcmsdh);
	if (bcmsdh_osinfo != NULL)
	MFREE(osh, bcmsdh_osinfo, sizeof(bcmsdh_os_info_t));
	return NULL;
	}

	int bcmsdh_remove(bcmsdh_info_t *bcmsdh)
	{
	bcmsdh_os_info_t *bcmsdh_osinfo = bcmsdh->os_cxt;

	#if !defined(CONFIG_HAS_WAKELOCK) && (LINUX_VERSION_CODE > KERNEL_VERSION(2, 6, 36))
	if (bcmsdh_osinfo->dev)
	device_init_wakeup(bcmsdh_osinfo->dev, false);
	bcmsdh_osinfo->dev_wake_enabled = FALSE;
	#endif /* !defined(CONFIG_HAS_WAKELOCK) && (LINUX_VERSION_CODE > KERNEL_VERSION(2, 6, 36)) */

	drvinfo.remove(bcmsdh_osinfo->context);
	MFREE(bcmsdh->osh, bcmsdh->os_cxt, sizeof(bcmsdh_os_info_t));
	bcmsdh_detach(bcmsdh->osh, bcmsdh);

	return 0;
	}

	int bcmsdh_suspend(bcmsdh_info_t *bcmsdh)
	{
	bcmsdh_os_info_t *bcmsdh_osinfo = bcmsdh->os_cxt;

	if (drvinfo.suspend && drvinfo.suspend(bcmsdh_osinfo->context))
	return -EBUSY;
	return 0;
	}

	int bcmsdh_resume(bcmsdh_info_t *bcmsdh)
	{
	bcmsdh_os_info_t *bcmsdh_osinfo = bcmsdh->os_cxt;

	if (drvinfo.resume)
	return drvinfo.resume(bcmsdh_osinfo->context);
	return 0;
	}

	extern int bcmsdh_register_client_driver(void);
	extern void bcmsdh_unregister_client_driver(void);
	extern int sdio_func_reg_notify(void* semaphore);
	extern void sdio_func_unreg_notify(void);

	#if defined(BCMLXSDMMC)
	int bcmsdh_reg_sdio_notify(void* semaphore)
	{
	return sdio_func_reg_notify(semaphore);
	}

	void bcmsdh_unreg_sdio_notify(void)
	{
	sdio_func_unreg_notify();
	}
	#endif /* defined(BCMLXSDMMC) */

	int
	bcmsdh_register(bcmsdh_driver_t *driver)
	{
	int error = 0;

	drvinfo = *driver;
	SDLX_MSG(("%s: register client driver\n", __FUNCTION__));
	error = bcmsdh_register_client_driver();
	if (error)
	SDLX_MSG(("%s: failed %d\n", __FUNCTION__, error));

	return error;
	}

	void
	bcmsdh_unregister(void)
	{
	#if (LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 0))
	if (bcmsdh_pci_driver.node.next == NULL)
	return;
	#endif

	bcmsdh_unregister_client_driver();
	}

	void bcmsdh_dev_pm_stay_awake(bcmsdh_info_t *bcmsdh)
	{
	#if !defined(CONFIG_HAS_WAKELOCK) && (LINUX_VERSION_CODE > KERNEL_VERSION(2, 6, 36))
	bcmsdh_os_info_t *bcmsdh_osinfo = bcmsdh->os_cxt;
	pm_stay_awake(bcmsdh_osinfo->dev);
	#endif /* !defined(CONFIG_HAS_WAKELOCK) && (LINUX_VERSION_CODE > KERNEL_VERSION(2, 6, 36)) */
	}

	void bcmsdh_dev_relax(bcmsdh_info_t *bcmsdh)
	{
	#if !defined(CONFIG_HAS_WAKELOCK) && (LINUX_VERSION_CODE > KERNEL_VERSION(2, 6, 36))
	bcmsdh_os_info_t *bcmsdh_osinfo = bcmsdh->os_cxt;
	pm_relax(bcmsdh_osinfo->dev);
	#endif /* !defined(CONFIG_HAS_WAKELOCK) && (LINUX_VERSION_CODE > KERNEL_VERSION(2, 6, 36)) */
	}

	bool bcmsdh_dev_pm_enabled(bcmsdh_info_t *bcmsdh)
	{
	bcmsdh_os_info_t *bcmsdh_osinfo = bcmsdh->os_cxt;

	return bcmsdh_osinfo->dev_wake_enabled;
	}

	#if defined(OOB_INTR_ONLY)
	void bcmsdh_oob_intr_set(bcmsdh_info_t *bcmsdh, bool enable)
	{
	unsigned long flags;
	bcmsdh_os_info_t *bcmsdh_osinfo;

	if (!bcmsdh)
	return;

	bcmsdh_osinfo = bcmsdh->os_cxt;
	spin_lock_irqsave(&bcmsdh_osinfo->oob_irq_spinlock, flags);
	if (bcmsdh_osinfo->oob_irq_enabled != enable) {
	if (enable)
	enable_irq(bcmsdh_osinfo->oob_irq_num);
	else
	disable_irq_nosync(bcmsdh_osinfo->oob_irq_num);
	bcmsdh_osinfo->oob_irq_enabled = enable;
	}
	spin_unlock_irqrestore(&bcmsdh_osinfo->oob_irq_spinlock, flags);
	}

	static irqreturn_t wlan_oob_irq(int irq, void *dev_id)
	{
	bcmsdh_info_t bcmsdh = (bcmsdh_info_t )dev_id;
	bcmsdh_os_info_t *bcmsdh_osinfo = bcmsdh->os_cxt;

	bcmsdh_oob_intr_set(bcmsdh, FALSE);
	bcmsdh_osinfo->oob_irq_handler(bcmsdh_osinfo->oob_irq_handler_context);

	return IRQ_HANDLED;
	}

	int bcmsdh_oob_intr_register(bcmsdh_info_t *bcmsdh, bcmsdh_cb_fn_t oob_irq_handler,
	void* oob_irq_handler_context)
	{
	int err = 0;
	bcmsdh_os_info_t *bcmsdh_osinfo = bcmsdh->os_cxt;

	SDLX_MSG(("%s: Enter\n", __FUNCTION__));
	if (bcmsdh_osinfo->oob_irq_registered) {
	SDLX_MSG(("%s: irq is already registered\n", __FUNCTION__));
	return -EBUSY;
	}
	#ifdef HW_OOB
	printf("%s: HW_OOB enabled\n", __FUNCTION__);
	#else
	printf("%s: SW_OOB enabled\n", __FUNCTION__);
	#endif
	SDLX_MSG(("%s OOB irq=%d flags=0x%X\n", __FUNCTION__,
	(int)bcmsdh_osinfo->oob_irq_num, (int)bcmsdh_osinfo->oob_irq_flags));
	bcmsdh_osinfo->oob_irq_handler = oob_irq_handler;
	bcmsdh_osinfo->oob_irq_handler_context = oob_irq_handler_context;
	bcmsdh_osinfo->oob_irq_enabled = TRUE;
	bcmsdh_osinfo->oob_irq_registered = TRUE;
	#if defined(CONFIG_ARCH_ODIN)
	err = odin_gpio_sms_request_irq(bcmsdh_osinfo->oob_irq_num, wlan_oob_irq,
	bcmsdh_osinfo->oob_irq_flags, "bcmsdh_sdmmc", bcmsdh);
	#else
	err = request_irq(bcmsdh_osinfo->oob_irq_num, wlan_oob_irq,
	bcmsdh_osinfo->oob_irq_flags, "bcmsdh_sdmmc", bcmsdh);
	#endif /* defined(CONFIG_ARCH_ODIN) */
	if (err) {
	bcmsdh_osinfo->oob_irq_enabled = FALSE;
	bcmsdh_osinfo->oob_irq_registered = FALSE;
	SDLX_MSG(("%s: request_irq failed with %d\n", __FUNCTION__, err));
	return err;
	}

	#if defined(DISABLE_WOWLAN)
	SDLX_MSG(("%s: disable_irq_wake\n", __FUNCTION__));
	bcmsdh_osinfo->oob_irq_wake_enabled = FALSE;
	#else
	SDLX_MSG(("%s: enable_irq_wake\n", __FUNCTION__));
	err = enable_irq_wake(bcmsdh_osinfo->oob_irq_num);
	if (err)
	SDLX_MSG(("%s: enable_irq_wake failed with %d\n", __FUNCTION__, err));
	else
	bcmsdh_osinfo->oob_irq_wake_enabled = TRUE;
	#endif

	return 0;
	}

	void bcmsdh_oob_intr_unregister(bcmsdh_info_t *bcmsdh)
	{
	int err = 0;
	bcmsdh_os_info_t *bcmsdh_osinfo = bcmsdh->os_cxt;

	SDLX_MSG(("%s: Enter\n", __FUNCTION__));
	if (!bcmsdh_osinfo->oob_irq_registered) {
	SDLX_MSG(("%s: irq is not registered\n", __FUNCTION__));
	return;
	}
	if (bcmsdh_osinfo->oob_irq_wake_enabled) {
	err = disable_irq_wake(bcmsdh_osinfo->oob_irq_num);
	if (!err)
	bcmsdh_osinfo->oob_irq_wake_enabled = FALSE;
	}
	if (bcmsdh_osinfo->oob_irq_enabled) {
	disable_irq(bcmsdh_osinfo->oob_irq_num);
	bcmsdh_osinfo->oob_irq_enabled = FALSE;
	}
	free_irq(bcmsdh_osinfo->oob_irq_num, bcmsdh);
	bcmsdh_osinfo->oob_irq_registered = FALSE;
	}
	#endif

	/* Module parameters specific to each host-controller driver */

	extern uint sd_msglevel; /* Debug message level */
	module_param(sd_msglevel, uint, 0);

	extern uint sd_power; /* 0 = SD Power OFF, 1 = SD Power ON. */
	module_param(sd_power, uint, 0);

	extern uint sd_clock; /* SD Clock Control, 0 = SD Clock OFF, 1 = SD Clock ON */
	module_param(sd_clock, uint, 0);

	extern uint sd_divisor; /* Divisor (-1 means external clock) */
	module_param(sd_divisor, uint, 0);

	extern uint sd_sdmode; /* Default is SD4, 0=SPI, 1=SD1, 2=SD4 */
	module_param(sd_sdmode, uint, 0);

	extern uint sd_hiok; /* Ok to use hi-speed mode */
	module_param(sd_hiok, uint, 0);

	extern uint sd_f2_blocksize;
	module_param(sd_f2_blocksize, int, 0);

	#ifdef BCMSDIOH_STD
	extern int sd_uhsimode;
	module_param(sd_uhsimode, int, 0);
	extern uint sd_tuning_period;
	module_param(sd_tuning_period, uint, 0);
	extern int sd_delay_value;
	module_param(sd_delay_value, uint, 0);

	/* SDIO Drive Strength for UHSI mode specific to SDIO3.0 */
	extern char dhd_sdiod_uhsi_ds_override[2];
	module_param_string(dhd_sdiod_uhsi_ds_override, dhd_sdiod_uhsi_ds_override, 2, 0);

	#endif

	#ifdef BCMSDH_MODULE
	EXPORT_SYMBOL(bcmsdh_attach);
	EXPORT_SYMBOL(bcmsdh_detach);
	EXPORT_SYMBOL(bcmsdh_intr_query);
	EXPORT_SYMBOL(bcmsdh_intr_enable);
	EXPORT_SYMBOL(bcmsdh_intr_disable);
	EXPORT_SYMBOL(bcmsdh_intr_reg);
	EXPORT_SYMBOL(bcmsdh_intr_dereg);

	#if defined(DHD_DEBUG)
	EXPORT_SYMBOL(bcmsdh_intr_pending);
	#endif

	EXPORT_SYMBOL(bcmsdh_devremove_reg);
	EXPORT_SYMBOL(bcmsdh_cfg_read);
	EXPORT_SYMBOL(bcmsdh_cfg_write);
	EXPORT_SYMBOL(bcmsdh_cis_read);
	EXPORT_SYMBOL(bcmsdh_reg_read);
	EXPORT_SYMBOL(bcmsdh_reg_write);
	EXPORT_SYMBOL(bcmsdh_regfail);
	EXPORT_SYMBOL(bcmsdh_send_buf);
	EXPORT_SYMBOL(bcmsdh_recv_buf);

	EXPORT_SYMBOL(bcmsdh_rwdata);
	EXPORT_SYMBOL(bcmsdh_abort);
	EXPORT_SYMBOL(bcmsdh_query_device);
	EXPORT_SYMBOL(bcmsdh_query_iofnum);
	EXPORT_SYMBOL(bcmsdh_iovar_op);
	EXPORT_SYMBOL(bcmsdh_register);
	EXPORT_SYMBOL(bcmsdh_unregister);
	EXPORT_SYMBOL(bcmsdh_chipmatch);
	EXPORT_SYMBOL(bcmsdh_reset);
	EXPORT_SYMBOL(bcmsdh_waitlockfree);

	EXPORT_SYMBOL(bcmsdh_get_dstatus);
	EXPORT_SYMBOL(bcmsdh_cfg_read_word);
	EXPORT_SYMBOL(bcmsdh_cfg_write_word);
	EXPORT_SYMBOL(bcmsdh_cur_sbwad);
	EXPORT_SYMBOL(bcmsdh_chipinfo);

	#endif /* BCMSDH_MODULE */