Quelle  btmrvl_drv.h   Sprache: C

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * Marvell Bluetooth driver: global definitions & declarations
 *
 * Copyright (C) 2009, Marvell International Ltd.
 */

#include <linux/kthread.h>
#include <linux/bitops.h>
#include <linux/slab.h>
#include <net/bluetooth/bluetooth.h>
#include <linux/err.h>
#include <linux/gfp.h>
#include <linux/interrupt.h>
#include <linux/io.h>
#include <linux/of_platform.h>
#include <linux/platform_device.h>
#include <linux/pm_runtime.h>
#include <linux/of_irq.h>

#define BTM_HEADER_LEN   4
#define BTM_UPLD_SIZE   2312

/* Time to wait until Host Sleep state change in millisecond */
#define WAIT_UNTIL_HS_STATE_CHANGED msecs_to_jiffies(5000)
/* Time to wait for command response in millisecond */
#define WAIT_UNTIL_CMD_RESP  msecs_to_jiffies(5000)

enum rdwr_status {
 RDWR_STATUS_SUCCESS = 0,
 RDWR_STATUS_FAILURE = 1,
 RDWR_STATUS_DONE = 2
};

#define FW_DUMP_MAX_NAME_LEN    8
#define FW_DUMP_HOST_READY      0xEE
#define FW_DUMP_DONE            0xFF
#define FW_DUMP_READ_DONE       0xFE

struct memory_type_mapping {
 u8 mem_name[FW_DUMP_MAX_NAME_LEN];
 u8 *mem_ptr;
 u32 mem_size;
 u8 done_flag;
};

struct btmrvl_thread {
 struct task_struct *task;
 wait_queue_head_t wait_q;
 void *priv;
};

struct btmrvl_device {
 void *card;
 struct hci_dev *hcidev;

 u8 dev_type;

 u8 tx_dnld_rdy;

 u8 psmode;
 u8 pscmd;
 u8 hsmode;
 u8 hscmd;

 /* Low byte is gap, high byte is GPIO */
 u16 gpio_gap;

 u8 hscfgcmd;
 u8 sendcmdflag;
};

struct btmrvl_adapter {
 void *hw_regs_buf;
 u8 *hw_regs;
 u32 int_count;
 struct sk_buff_head tx_queue;
 u8 psmode;
 u8 ps_state;
 u8 hs_state;
 u8 wakeup_tries;
 wait_queue_head_t cmd_wait_q;
 wait_queue_head_t event_hs_wait_q;
 u8 cmd_complete;
 bool is_suspended;
 bool is_suspending;
};

struct btmrvl_private {
 struct btmrvl_device btmrvl_dev;
 struct btmrvl_adapter *adapter;
 struct btmrvl_thread main_thread;
 int (*hw_host_to_card)(struct btmrvl_private *priv,
    u8 *payload, u16 nb);
 int (*hw_wakeup_firmware)(struct btmrvl_private *priv);
 int (*hw_process_int_status)(struct btmrvl_private *priv);
 spinlock_t driver_lock;  /* spinlock used by driver */
#ifdef CONFIG_DEBUG_FS
 void *debugfs_data;
#endif
 bool surprise_removed;
};

#define MRVL_VENDOR_PKT   0xFE

/* Vendor specific Bluetooth commands */
#define BT_CMD_PSCAN_WIN_REPORT_ENABLE 0xFC03
#define BT_CMD_ROUTE_SCO_TO_HOST 0xFC1D
#define BT_CMD_SET_BDADDR  0xFC22
#define BT_CMD_AUTO_SLEEP_MODE  0xFC23
#define BT_CMD_HOST_SLEEP_CONFIG 0xFC59
#define BT_CMD_HOST_SLEEP_ENABLE 0xFC5A
#define BT_CMD_MODULE_CFG_REQ  0xFC5B
#define BT_CMD_LOAD_CONFIG_DATA  0xFC61

/* Sub-commands: Module Bringup/Shutdown Request/Response */
#define MODULE_BRINGUP_REQ  0xF1
#define MODULE_BROUGHT_UP  0x00
#define MODULE_ALREADY_UP  0x0C

#define MODULE_SHUTDOWN_REQ  0xF2

/* Vendor specific Bluetooth events */
#define BT_EVENT_AUTO_SLEEP_MODE 0x23
#define BT_EVENT_HOST_SLEEP_CONFIG 0x59
#define BT_EVENT_HOST_SLEEP_ENABLE 0x5A
#define BT_EVENT_MODULE_CFG_REQ  0x5B
#define BT_EVENT_POWER_STATE  0x20

/* Bluetooth Power States */
#define BT_PS_ENABLE   0x02
#define BT_PS_DISABLE   0x03
#define BT_PS_SLEEP   0x01

/* Host Sleep states */
#define HS_ACTIVATED   0x01
#define HS_DEACTIVATED   0x00

/* Power Save modes */
#define PS_SLEEP   0x01
#define PS_AWAKE   0x00

#define BT_CAL_HDR_LEN   4
#define BT_CAL_DATA_SIZE  28

struct btmrvl_event {
 u8 ec;  /* event counter */
 u8 length;
 u8 data[4];
} __packed;

/* Prototype of global function */

int btmrvl_register_hdev(struct btmrvl_private *priv);
struct btmrvl_private *btmrvl_add_card(void *card);
int btmrvl_remove_card(struct btmrvl_private *priv);

void btmrvl_interrupt(struct btmrvl_private *priv);

bool btmrvl_check_evtpkt(struct btmrvl_private *priv, struct sk_buff *skb);
int btmrvl_process_event(struct btmrvl_private *priv, struct sk_buff *skb);

int btmrvl_send_module_cfg_cmd(struct btmrvl_private *priv, u8 subcmd);
int btmrvl_pscan_window_reporting(struct btmrvl_private *priv, u8 subcmd);
int btmrvl_send_hscfg_cmd(struct btmrvl_private *priv);
int btmrvl_enable_ps(struct btmrvl_private *priv);
int btmrvl_prepare_command(struct btmrvl_private *priv);
int btmrvl_enable_hs(struct btmrvl_private *priv);

#ifdef CONFIG_DEBUG_FS
void btmrvl_debugfs_init(struct hci_dev *hdev);
void btmrvl_debugfs_remove(struct hci_dev *hdev);
#endif