/**
 * hw_types.h
 *
 * Hardware types and definitions
 */
#ifndef _WIMAX_HW_TYPES_H
#define _WIMAX_HW_TYPES_H

#include "ctl_types.h"

/* private protocol defines */
#define HW_PROT_VALUE_LINK_DOWN			0x00
#define HW_PROT_VALUE_LINK_UP			0xff

/* SDIO general defines */
#define SDIO_BANK_SIZE					4096 /* size of a bank in cmc's rx and tx buffers */
#define SDIO_MAX_BLOCK_SIZE			2048	/* maximum block size (SDIO) */
#define SDIO_MAX_BYTE_SIZE			511	/* maximum size in byte mode */
#define SDIO_BUFFER_SIZE			SDIO_MAX_BLOCK_SIZE
/*
  *We need the HEADER_MANIPULATION_OFFSET because
  *we now use only one buffer while receiving data.
  *since the ehternet header is larger than the hardware packet header,
  *we need to keep some space at the beginning of the buffer to accomodate the
  *ethernet header. 8 bytes is enough for this purpose.
  */
#define HEADER_MANIPULATION_OFFSET	8
/* SDIO function addresses  */
#define SDIO_TX_BANK_ADDR			0x1000
#define SDIO_RX_BANK_ADDR			0x10000
#define SDIO_INT_STATUS_REG		0xC0
#define SDIO_INT_STATUS_CLR_REG	0xC4

#define SDIO_C2H_WP_REG			0xE4
#define SDIO_C2H_RP_REG			0xE8
#define SDIO_H2C_WP_REG			0xEC
#define SDIO_H2C_RP_REG			0xF0

/* SDIO function registers */
#define SDIO_INT_DATA_READY			0x01
#define SDIO_INT_ERROR				0x02

#define WAKEUP_MAX_TRY				20
#define WAKEUP_TIMEOUT				300
#define CONTROL_PACKET				1
#define DATA_PACKET				0

/* packet types */
enum {
	HwPktTypeNone = 0xff00,
	HwPktTypePrivate,
	HwPktTypeControl,
	HwPktTypeData,
	HwPktTypeTimeout
};

/* private packet opcodes */
enum {
	HwCodeMacRequest = 0x01,
	HwCodeMacResponse,
	HwCodeLinkIndication,
	HwCodeRxReadyIndication,
	HwCodeHaltedIndication,
	HwCodeIdleNtfy,
	HwCodeWakeUpNtfy
};


#pragma pack(1)
struct hw_packet_header {
	char		id0;	/* packet ID */
	char		id1;
	u_short	length;	/* packet length */
};

struct hw_private_packet {
	char		id0;	/* packet ID */
	char		id1;
	u_char	code;	/* command code */
	u_char	value;	/* command value */
};
#pragma pack()

struct wimax_msg_header {
	u_short	type;
	u_short	id;
	u_int	length;
};

struct hardware_info {
	void			*receive_buffer;
	u_char		eth_header[ETHERNET_ADDRESS_LENGTH * 2];	/* ethernet header */
	struct queue_info	q_send;					/* send pending queue */
};

#endif	/* _WIMAX_HW_TYPES_H */