[deliverable/linux.git] / drivers / bluetooth / btmrvl_sdio.h

/**
 * Marvell BT-over-SDIO driver: SDIO interface related definitions
 *
 * Copyright (C) 2009, Marvell International Ltd.
 *
 * This software file (the "File") is distributed by Marvell International
 * Ltd. under the terms of the GNU General Public License Version 2, June 1991
 * (the "License").  You may use, redistribute and/or modify this File in
 * accordance with the terms and conditions of the License, a copy of which
 * is available by writing to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or on the
 * worldwide web at http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
 *
 *
 * THE FILE IS DISTRIBUTED AS-IS, WITHOUT WARRANTY OF ANY KIND, AND THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE
 * ARE EXPRESSLY DISCLAIMED.  The License provides additional details about
 * this warranty disclaimer.
 *
 **/

#define SDIO_HEADER_LEN			4

/* SD block size can not bigger than 64 due to buf size limit in firmware */
/* define SD block size for data Tx/Rx */
#define SDIO_BLOCK_SIZE			64

/* Number of blocks for firmware transfer */
#define FIRMWARE_TRANSFER_NBLOCK	2

/* This is for firmware specific length */
#define FW_EXTRA_LEN			36

#define MRVDRV_SIZE_OF_CMD_BUFFER       (2 * 1024)

#define MRVDRV_BT_RX_PACKET_BUFFER_SIZE \
	(HCI_MAX_FRAME_SIZE + FW_EXTRA_LEN)

#define ALLOC_BUF_SIZE	(((max_t (int, MRVDRV_BT_RX_PACKET_BUFFER_SIZE, \
			MRVDRV_SIZE_OF_CMD_BUFFER) + SDIO_HEADER_LEN \
			+ SDIO_BLOCK_SIZE - 1) / SDIO_BLOCK_SIZE) \
			* SDIO_BLOCK_SIZE)

/* The number of times to try when polling for status */
#define MAX_POLL_TRIES			100

/* Max retry number of CMD53 write */
#define MAX_WRITE_IOMEM_RETRY		2

/* register bitmasks */
#define HOST_POWER_UP				BIT(1)
#define HOST_CMD53_FIN				BIT(2)

#define HIM_DISABLE				0xff
#define HIM_ENABLE				(BIT(0) | BIT(1))

#define UP_LD_HOST_INT_STATUS			BIT(0)
#define DN_LD_HOST_INT_STATUS			BIT(1)

#define DN_LD_CARD_RDY				BIT(0)
#define CARD_IO_READY				BIT(3)

#define FIRMWARE_READY				0xfedc


struct btmrvl_sdio_card_reg {
	u8 cfg;
	u8 host_int_mask;
	u8 host_intstatus;
	u8 card_status;
	u8 sq_read_base_addr_a0;
	u8 sq_read_base_addr_a1;
	u8 card_revision;
	u8 card_fw_status0;
	u8 card_fw_status1;
	u8 card_rx_len;
	u8 card_rx_unit;
	u8 io_port_0;
	u8 io_port_1;
	u8 io_port_2;
	bool int_read_to_clear;
	u8 host_int_rsr;
	u8 card_misc_cfg;
	u8 fw_dump_ctrl;
	u8 fw_dump_start;
	u8 fw_dump_end;
};

struct btmrvl_sdio_card {
	struct sdio_func *func;
	u32 ioport;
	const char *helper;
	const char *firmware;
	const struct btmrvl_sdio_card_reg *reg;
	bool support_pscan_win_report;
	bool supports_fw_dump;
	u16 sd_blksz_fw_dl;
	u8 rx_unit;
	struct btmrvl_private *priv;
};

struct btmrvl_sdio_device {
	const char *helper;
	const char *firmware;
	const struct btmrvl_sdio_card_reg *reg;
	const bool support_pscan_win_report;
	u16 sd_blksz_fw_dl;
	bool supports_fw_dump;
};


/* Platform specific DMA alignment */
#define BTSDIO_DMA_ALIGN		8

/* Macros for Data Alignment : size */
#define ALIGN_SZ(p, a)	\
	(((p) + ((a) - 1)) & ~((a) - 1))

/* Macros for Data Alignment : address */
#define ALIGN_ADDR(p, a)	\
	((((unsigned long)(p)) + (((unsigned long)(a)) - 1)) & \
					~(((unsigned long)(a)) - 1))
Commit	Line	Data
789221ec BZ	1	/**
	2	* Marvell BT-over-SDIO driver: SDIO interface related definitions
	3	*
	4	* Copyright (C) 2009, Marvell International Ltd.
	5	*
	6	* This software file (the "File") is distributed by Marvell International
	7	* Ltd. under the terms of the GNU General Public License Version 2, June 1991
	8	* (the "License"). You may use, redistribute and/or modify this File in
	9	* accordance with the terms and conditions of the License, a copy of which
	10	* is available by writing to the Free Software Foundation, Inc.,
	11	* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or on the
	12	* worldwide web at http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
	13	*
	14	*
	15	* THE FILE IS DISTRIBUTED AS-IS, WITHOUT WARRANTY OF ANY KIND, AND THE
	16	* IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE
	17	* ARE EXPRESSLY DISCLAIMED. The License provides additional details about
	18	* this warranty disclaimer.
	19	*
	20	**/
	21
789221ec BZ	22	#define SDIO_HEADER_LEN 4
	23
	24	/* SD block size can not bigger than 64 due to buf size limit in firmware */
	25	/* define SD block size for data Tx/Rx */
	26	#define SDIO_BLOCK_SIZE 64
	27
	28	/* Number of blocks for firmware transfer */
	29	#define FIRMWARE_TRANSFER_NBLOCK 2
	30
	31	/* This is for firmware specific length */
	32	#define FW_EXTRA_LEN 36
	33
	34	#define MRVDRV_SIZE_OF_CMD_BUFFER (2 * 1024)
	35
	36	#define MRVDRV_BT_RX_PACKET_BUFFER_SIZE \
	37	(HCI_MAX_FRAME_SIZE + FW_EXTRA_LEN)
	38
	39	#define ALLOC_BUF_SIZE (((max_t (int, MRVDRV_BT_RX_PACKET_BUFFER_SIZE, \
	40	MRVDRV_SIZE_OF_CMD_BUFFER) + SDIO_HEADER_LEN \
	41	+ SDIO_BLOCK_SIZE - 1) / SDIO_BLOCK_SIZE) \
	42	* SDIO_BLOCK_SIZE)
	43
	44	/* The number of times to try when polling for status */
	45	#define MAX_POLL_TRIES 100
	46
	47	/* Max retry number of CMD53 write */
	48	#define MAX_WRITE_IOMEM_RETRY 2
	49
9f72c1d9 KG	50	/* register bitmasks */
	51	#define HOST_POWER_UP BIT(1)
	52	#define HOST_CMD53_FIN BIT(2)
	53
	54	#define HIM_DISABLE 0xff
	55	#define HIM_ENABLE (BIT(0) \| BIT(1))
	56
	57	#define UP_LD_HOST_INT_STATUS BIT(0)
	58	#define DN_LD_HOST_INT_STATUS BIT(1)
	59
	60	#define DN_LD_CARD_RDY BIT(0)
	61	#define CARD_IO_READY BIT(3)
	62
	63	#define FIRMWARE_READY 0xfedc
	64
	65
	66	struct btmrvl_sdio_card_reg {
	67	u8 cfg;
	68	u8 host_int_mask;
	69	u8 host_intstatus;
	70	u8 card_status;
	71	u8 sq_read_base_addr_a0;
	72	u8 sq_read_base_addr_a1;
	73	u8 card_revision;
	74	u8 card_fw_status0;
	75	u8 card_fw_status1;
	76	u8 card_rx_len;
	77	u8 card_rx_unit;
	78	u8 io_port_0;
	79	u8 io_port_1;
	80	u8 io_port_2;
0d367408 BZ	81	bool int_read_to_clear;
	82	u8 host_int_rsr;
	83	u8 card_misc_cfg;
dc759613 XH	84	u8 fw_dump_ctrl;
	85	u8 fw_dump_start;
	86	u8 fw_dump_end;
9f72c1d9	87	};
789221ec BZ	88
	89	struct btmrvl_sdio_card {
	90	struct sdio_func *func;
	91	u32 ioport;
	92	const char *helper;
	93	const char *firmware;
9f72c1d9	94	const struct btmrvl_sdio_card_reg *reg;
4df82b59	95	bool support_pscan_win_report;
dc759613	96	bool supports_fw_dump;
9f72c1d9	97	u16 sd_blksz_fw_dl;
789221ec BZ	98	u8 rx_unit;
	99	struct btmrvl_private *priv;
	100	};
	101
	102	struct btmrvl_sdio_device {
789221ec BZ	103	const char *helper;
789221ec BZ	104	const char *firmware;
9f72c1d9	105	const struct btmrvl_sdio_card_reg *reg;
4df82b59	106	const bool support_pscan_win_report;
9f72c1d9	107	u16 sd_blksz_fw_dl;
dc759613	108	bool supports_fw_dump;
789221ec BZ	109	};
	110
	111
	112	/* Platform specific DMA alignment */
	113	#define BTSDIO_DMA_ALIGN 8
	114
	115	/* Macros for Data Alignment : size */
	116	#define ALIGN_SZ(p, a) \
	117	(((p) + ((a) - 1)) & ~((a) - 1))
	118
	119	/* Macros for Data Alignment : address */
	120	#define ALIGN_ADDR(p, a) \
3318b236 BZ	121	((((unsigned long)(p)) + (((unsigned long)(a)) - 1)) & \
3318b236 BZ	122	~(((unsigned long)(a)) - 1))