blob: 845a7c5882a25615b294c3ac32473d44fa29f145 [file] [log] [blame]
/*
*
* Copyright (c) 2011 Code Aurora Forum. All rights reserved.
*
* This file is based on include/net/bluetooth/hci_core.h
*
* Written 2000,2001 by Maxim Krasnyansky <maxk@qualcomm.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS.
* IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) AND AUTHOR(S) BE LIABLE FOR ANY
* CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*
* ALL LIABILITY, INCLUDING LIABILITY FOR INFRINGEMENT OF ANY PATENTS,
* COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS, RELATING TO USE OF THIS
* SOFTWARE IS DISCLAIMED.
*/
#ifndef __RADIO_HCI_CORE_H
#define __RADIO_HCI_CORE_H
#include <linux/skbuff.h>
#include <linux/interrupt.h>
#include <linux/mutex.h>
#include <linux/atomic.h>
/* ---- HCI Packet structures ---- */
#define RADIO_HCI_COMMAND_HDR_SIZE sizeof(struct radio_hci_command_hdr)
#define RADIO_HCI_EVENT_HDR_SIZE sizeof(struct radio_hci_event_hdr)
/* HCI data types */
#define RADIO_HCI_COMMAND_PKT 0x11
#define RADIO_HCI_EVENT_PKT 0x14
/* HCI timeouts */
#define RADIO_HCI_TIMEOUT (10000) /* 10 seconds */
#define TUNE_PARAM 16
struct radio_hci_command_hdr {
__le16 opcode; /* OCF & OGF */
__u8 plen;
} __packed;
struct radio_hci_event_hdr {
__u8 evt;
__u8 plen;
} __packed;
struct radio_hci_dev {
char name[8];
unsigned long flags;
__u16 id;
__u8 bus;
__u8 dev_type;
__u8 dev_name[248];
__u8 dev_class[3];
__u8 features[8];
__u8 commands[64];
unsigned int data_block_len;
unsigned long cmd_last_tx;
struct sk_buff *sent_cmd;
__u32 req_status;
__u32 req_result;
atomic_t cmd_cnt;
struct tasklet_struct cmd_task;
struct tasklet_struct rx_task;
struct tasklet_struct tx_task;
struct sk_buff_head rx_q;
struct sk_buff_head raw_q;
struct sk_buff_head cmd_q;
struct mutex req_lock;
wait_queue_head_t req_wait_q;
int (*open)(struct radio_hci_dev *hdev);
int (*close)(struct radio_hci_dev *hdev);
int (*flush)(struct radio_hci_dev *hdev);
int (*send)(struct sk_buff *skb);
void (*destruct)(struct radio_hci_dev *hdev);
void (*notify)(struct radio_hci_dev *hdev, unsigned int evt);
};
int radio_hci_register_dev(struct radio_hci_dev *hdev);
int radio_hci_unregister_dev(struct radio_hci_dev *hdev);
int radio_hci_recv_frame(struct sk_buff *skb);
int radio_hci_send_cmd(struct radio_hci_dev *hdev, __u16 opcode, __u32 plen,
void *param);
void radio_hci_event_packet(struct radio_hci_dev *hdev, struct sk_buff *skb);
/* Opcode OCF */
/* HCI recv control commands opcode */
#define HCI_OCF_FM_ENABLE_RECV_REQ 0x0001
#define HCI_OCF_FM_DISABLE_RECV_REQ 0x0002
#define HCI_OCF_FM_GET_RECV_CONF_REQ 0x0003
#define HCI_OCF_FM_SET_RECV_CONF_REQ 0x0004
#define HCI_OCF_FM_SET_MUTE_MODE_REQ 0x0005
#define HCI_OCF_FM_SET_STEREO_MODE_REQ 0x0006
#define HCI_OCF_FM_SET_ANTENNA 0x0007
#define HCI_OCF_FM_SET_SIGNAL_THRESHOLD 0x0008
#define HCI_OCF_FM_GET_SIGNAL_THRESHOLD 0x0009
#define HCI_OCF_FM_GET_STATION_PARAM_REQ 0x000A
#define HCI_OCF_FM_GET_PROGRAM_SERVICE_REQ 0x000B
#define HCI_OCF_FM_GET_RADIO_TEXT_REQ 0x000C
#define HCI_OCF_FM_GET_AF_LIST_REQ 0x000D
#define HCI_OCF_FM_SEARCH_STATIONS 0x000E
#define HCI_OCF_FM_SEARCH_RDS_STATIONS 0x000F
#define HCI_OCF_FM_SEARCH_STATIONS_LIST 0x0010
#define HCI_OCF_FM_CANCEL_SEARCH 0x0011
#define HCI_OCF_FM_RDS_GRP 0x0012
#define HCI_OCF_FM_RDS_GRP_PROCESS 0x0013
#define HCI_OCF_FM_EN_WAN_AVD_CTRL 0x0014
#define HCI_OCF_FM_EN_NOTCH_CTRL 0x0015
/* HCI common control commands opcode */
#define HCI_OCF_FM_TUNE_STATION_REQ 0x0001
#define HCI_OCF_FM_DEFAULT_DATA_READ 0x0002
#define HCI_OCF_FM_DEFAULT_DATA_WRITE 0x0003
#define HCI_OCF_FM_RESET 0x0004
#define HCI_OCF_FM_GET_FEATURE_LIST 0x0005
#define HCI_OCF_FM_DO_CALIBRATION 0x0006
/*HCI Status parameters commands*/
#define HCI_OCF_FM_READ_GRP_COUNTERS 0x0001
/*HCI Diagnostic commands*/
#define HCI_OCF_FM_PEEK_DATA 0x0002
#define HCI_OCF_FM_POKE_DATA 0x0003
#define HCI_OCF_FM_SSBI_PEEK_REG 0x0004
#define HCI_OCF_FM_SSBI_POKE_REG 0x0005
#define HCI_OCF_FM_STATION_DBG_PARAM 0x0007
/* Opcode OGF */
#define HCI_OGF_FM_RECV_CTRL_CMD_REQ 0x0013
#define HCI_OGF_FM_COMMON_CTRL_CMD_REQ 0x0015
#define HCI_OGF_FM_STATUS_PARAMETERS_CMD_REQ 0x0016
#define HCI_OGF_FM_TEST_CMD_REQ 0x0017
#define HCI_OGF_FM_DIAGNOSTIC_CMD_REQ 0x003F
/* Command opcode pack/unpack */
#define hci_opcode_pack(ogf, ocf) (__u16) ((ocf & 0x03ff)|(ogf << 10))
#define hci_opcode_ogf(op) (op >> 10)
#define hci_opcode_ocf(op) (op & 0x03ff)
#define hci_recv_ctrl_cmd_op_pack(ocf) \
(__u16) hci_opcode_pack(HCI_OGF_FM_RECV_CTRL_CMD_REQ, ocf)
#define hci_common_cmd_op_pack(ocf) \
(__u16) hci_opcode_pack(HCI_OGF_FM_COMMON_CTRL_CMD_REQ, ocf)
#define hci_status_param_op_pack(ocf) \
(__u16) hci_opcode_pack(HCI_OGF_FM_STATUS_PARAMETERS_CMD_REQ, ocf)
#define hci_diagnostic_cmd_op_pack(ocf) \
(__u16) hci_opcode_pack(HCI_OGF_FM_DIAGNOSTIC_CMD_REQ, ocf)
/* HCI commands with no arguments*/
#define HCI_FM_ENABLE_RECV_CMD 1
#define HCI_FM_DISABLE_RECV_CMD 2
#define HCI_FM_GET_RECV_CONF_CMD 3
#define HCI_FM_GET_STATION_PARAM_CMD 4
#define HCI_FM_GET_SIGNAL_TH_CMD 5
#define HCI_FM_GET_PROGRAM_SERVICE_CMD 6
#define HCI_FM_GET_RADIO_TEXT_CMD 7
#define HCI_FM_GET_AF_LIST_CMD 8
#define HCI_FM_CANCEL_SEARCH_CMD 9
#define HCI_FM_RESET_CMD 10
#define HCI_FM_GET_FEATURES_CMD 11
#define HCI_FM_STATION_DBG_PARAM_CMD 12
/* ----- HCI Command request ----- */
struct hci_fm_recv_conf_req {
__u8 emphasis;
__u8 ch_spacing;
__u8 rds_std;
__u8 hlsi;
__u32 band_low_limit;
__u32 band_high_limit;
} __packed;
struct hci_fm_mute_mode_req {
__u8 hard_mute;
__u8 soft_mute;
} __packed;
struct hci_fm_stereo_mode_req {
__u8 stereo_mode;
__u8 sig_blend;
__u8 intf_blend;
__u8 most_switch;
} __packed;
struct hci_fm_search_station_req {
__u8 srch_mode;
__u8 scan_time;
__u8 srch_dir;
} __packed;
struct hci_fm_search_rds_station_req {
struct hci_fm_search_station_req srch_station;
__u8 srch_pty;
__u16 srch_pi;
} __packed;
struct hci_fm_search_station_list_req {
__u8 srch_list_mode;
__u8 srch_list_dir;
__u32 srch_list_max;
__u8 srch_pty;
} __packed;
struct hci_fm_rds_grp_req {
__u32 rds_grp_enable_mask;
__u32 rds_buf_size;
__u8 en_rds_change_filter;
} __packed;
struct hci_fm_en_avd_ctrl_req {
__u8 no_freqs;
__u8 freq_index;
__u8 lo_shft;
__u16 freq_min;
__u16 freq_max;
} __packed;
struct hci_fm_def_data_rd_req {
__u8 mode;
__u8 length;
} __packed;
struct hci_fm_def_data_wr_req {
struct hci_fm_def_data_rd_req data_rd;
__u8 data[256];
} __packed;
struct hci_fm_peek_req {
__u32 start_addr;
__u8 length;
} __packed;
struct hci_fm_poke_req {
struct hci_fm_peek_req peek_req;
__u8 data[256];
} __packed;
struct hci_fm_ssbi_req {
__u16 start_addr;
__u8 data;
} __packed;
/*HCI events*/
#define HCI_EV_TUNE_STATUS 0x01
#define HCI_EV_RDS_LOCK_STATUS 0x02
#define HCI_EV_STEREO_STATUS 0x03
#define HCI_EV_SERVICE_AVAILABLE 0x04
#define HCI_EV_SEARCH_PROGRESS 0x05
#define HCI_EV_SEARCH_RDS_PROGRESS 0x06
#define HCI_EV_SEARCH_LIST_PROGRESS 0x07
#define HCI_EV_RDS_RX_DATA 0x08
#define HCI_EV_PROGRAM_SERVICE 0x09
#define HCI_EV_RADIO_TEXT 0x0A
#define HCI_EV_FM_AF_LIST 0x0B
#define HCI_EV_TX_RDS_GRP_AVBLE 0x0C
#define HCI_EV_TX_RDS_GRP_COMPL 0x0D
#define HCI_EV_TX_RDS_CONT_GRP_COMPL 0x0E
#define HCI_EV_CMD_COMPLETE 0x0F
#define HCI_EV_CMD_STATUS 0x10
#define HCI_EV_TUNE_COMPLETE 0x11
#define HCI_EV_SEARCH_COMPLETE 0x12
#define HCI_EV_SEARCH_RDS_COMPLETE 0x13
#define HCI_EV_SEARCH_LIST_COMPLETE 0x14
#define HCI_REQ_DONE 0
#define HCI_REQ_PEND 1
#define HCI_REQ_CANCELED 2
#define HCI_REQ_STATUS 3
struct hci_ev_tune_status {
__u8 sub_event;
__le32 station_freq;
__u8 serv_avble;
__u8 rssi;
__u8 stereo_prg;
__u8 rds_sync_status;
__u8 mute_mode;
} __packed;
struct hci_ev_rds_rx_data {
__u8 num_rds_grps;
__u8 rds_grp_data[12];
} __packed;
struct hci_ev_prg_service {
__le16 pi_prg_id;
__u8 pty_prg_type;
__u8 ta_prg_code_type;
__u8 ta_ann_code_flag;
__u8 ms_switch_code_flag;
__u8 dec_id_ctrl_code_flag;
__u8 ps_num;
__u8 prg_service_name[119];
} __packed;
struct hci_ev_radio_text {
__le16 pi_prg_id;
__u8 pty_prg_type;
__u8 ta_prg_code_type;
__u8 txt_ab_flag;
__u8 radio_txt[64];
} __packed;
struct hci_ev_af_list {
__le32 tune_freq;
__le16 pi_code;
__u8 af_size;
__u8 af_list[25];
} __packed;
struct hci_ev_cmd_complete {
__u8 num_hci_cmd_pkts;
__le16 cmd_opcode;
} __packed;
struct hci_ev_cmd_status {
__u8 status;
__u8 num_hci_cmd_pkts;
__le16 status_opcode;
} __packed;
struct hci_ev_srch_st {
__le32 station_freq;
__u8 rds_cap;
__u8 pty;
__le16 status_opcode;
} __packed;
struct hci_ev_rel_freq {
__u8 rel_freq_msb;
__u8 rel_freq_lsb;
} __packed;
struct hci_ev_srch_list_compl {
__u8 num_stations_found;
struct hci_ev_rel_freq rel_freq[20];
} __packed;
/* ----- HCI Event Response ----- */
struct hci_fm_conf_rsp {
__u8 status;
struct hci_fm_recv_conf_req recv_conf_rsp;
} __packed;
struct hci_fm_sig_threshold_rsp {
__u8 status;
__u8 sig_threshold;
} __packed;
struct hci_fm_station_rsp {
struct hci_ev_tune_status station_rsp;
} __packed;
struct hci_fm_prgm_srv_rsp {
__u8 status;
struct hci_ev_prg_service prg_srv;
} __packed;
struct hci_fm_radio_txt_rsp {
__u8 status;
struct hci_ev_radio_text rd_txt;
} __packed;
struct hci_fm_af_list_rsp {
__u8 status;
struct hci_ev_af_list rd_txt;
} __packed;
struct hci_fm_data_rd_rsp {
__u8 status;
__u8 ret_data_len;
__u8 data[256];
} __packed;
struct hci_fm_feature_list_rsp {
__u8 status;
__u8 feature_mask;
} __packed;
struct hci_fm_dbg_param_rsp {
__u8 status;
__u8 blend;
__u8 soft_mute;
__u8 inf_blend;
__u8 inf_soft_mute;
__u8 pilot_pil;
__u8 io_verc;
__u8 in_det_out;
} __packed;
/* HCI dev events */
#define RADIO_HCI_DEV_REG 1
#define RADIO_HCI_DEV_WRITE 2
#define hci_req_lock(d) mutex_lock(&d->req_lock)
#define hci_req_unlock(d) mutex_unlock(&d->req_lock)
/* FM RDS */
#define RDS_PTYPE 0
#define RDS_PID_LOWER 2
#define RDS_PID_HIGHER 3
#define RDS_OFFSET 5
#define RDS_PS_LENGTH_OFFSET 7
#define RDS_STRING 8
#define RDS_PS_DATA_OFFSET 8
/*FM states*/
enum radio_state_t {
FM_OFF,
FM_RECV,
FM_TRANS,
FM_RESET,
};
enum v4l2_cid_private_iris_t {
V4L2_CID_PRIVATE_IRIS_SRCHMODE = (0x08000000 + 1),
V4L2_CID_PRIVATE_IRIS_SCANDWELL,
V4L2_CID_PRIVATE_IRIS_SRCHON,
V4L2_CID_PRIVATE_IRIS_STATE,
V4L2_CID_PRIVATE_IRIS_TRANSMIT_MODE,
V4L2_CID_PRIVATE_IRIS_RDSGROUP_MASK,
V4L2_CID_PRIVATE_IRIS_REGION,
V4L2_CID_PRIVATE_IRIS_SIGNAL_TH,
V4L2_CID_PRIVATE_IRIS_SRCH_PTY,
V4L2_CID_PRIVATE_IRIS_SRCH_PI,
V4L2_CID_PRIVATE_IRIS_SRCH_CNT,
V4L2_CID_PRIVATE_IRIS_EMPHASIS,
V4L2_CID_PRIVATE_IRIS_RDS_STD,
V4L2_CID_PRIVATE_IRIS_SPACING,
V4L2_CID_PRIVATE_IRIS_RDSON,
V4L2_CID_PRIVATE_IRIS_RDSGROUP_PROC,
V4L2_CID_PRIVATE_IRIS_LP_MODE,
V4L2_CID_PRIVATE_IRIS_ANTENNA,
V4L2_CID_PRIVATE_IRIS_RDSD_BUF,
V4L2_CID_PRIVATE_IRIS_PSALL,
/*v4l2 Tx controls*/
V4L2_CID_PRIVATE_IRIS_TX_SETPSREPEATCOUNT,
V4L2_CID_PRIVATE_IRIS_STOP_RDS_TX_PS_NAME,
V4L2_CID_PRIVATE_IRIS_STOP_RDS_TX_RT,
V4L2_CID_PRIVATE_IRIS_IOVERC,
V4L2_CID_PRIVATE_IRIS_INTDET,
};
enum iris_evt_t {
IRIS_EVT_RADIO_READY,
IRIS_EVT_TUNE_SUCC,
IRIS_EVT_SEEK_COMPLETE,
IRIS_EVT_SCAN_NEXT,
IRIS_EVT_NEW_RAW_RDS,
IRIS_EVT_NEW_RT_RDS,
IRIS_EVT_NEW_PS_RDS,
IRIS_EVT_ERROR,
IRIS_EVT_BELOW_TH,
IRIS_EVT_ABOVE_TH,
IRIS_EVT_STEREO,
IRIS_EVT_MONO,
IRIS_EVT_RDS_AVAIL,
IRIS_EVT_RDS_NOT_AVAIL,
IRIS_EVT_NEW_SRCH_LIST,
IRIS_EVT_NEW_AF_LIST,
IRIS_EVT_TXRDSDAT,
IRIS_EVT_TXRDSDONE
};
enum iris_region_t {
IRIS_REGION_US,
IRIS_REGION_EU,
IRIS_REGION_JAPAN,
IRIS_REGION_JAPAN_WIDE,
IRIS_REGION_OTHER
};
#define STD_BUF_SIZE (64)
enum iris_buf_t {
IRIS_BUF_SRCH_LIST,
IRIS_BUF_EVENTS,
IRIS_BUF_RT_RDS,
IRIS_BUF_PS_RDS,
IRIS_BUF_RAW_RDS,
IRIS_BUF_AF_LIST,
IRIS_BUF_MAX
};
enum iris_xfr_t {
IRIS_XFR_SYNC,
IRIS_XFR_ERROR,
IRIS_XFR_SRCH_LIST,
IRIS_XFR_RT_RDS,
IRIS_XFR_PS_RDS,
IRIS_XFR_AF_LIST,
IRIS_XFR_MAX
};
#undef FMDBG
#ifdef FM_DEBUG
#define FMDBG(fmt, args...) pr_info("iris_radio: " fmt, ##args)
#else
#define FMDBG(fmt, args...)
#endif
#undef FMDERR
#define FMDERR(fmt, args...) pr_err("iris_radio: " fmt, ##args)
/* Search options */
enum search_t {
SEEK,
SCAN,
SCAN_FOR_STRONG,
SCAN_FOR_WEAK,
RDS_SEEK_PTY,
RDS_SCAN_PTY,
RDS_SEEK_PI,
RDS_AF_JUMP,
};
#define SRCH_MODE 0x07
#define SRCH_DIR 0x08 /* 0-up 1-down */
#define SCAN_DWELL 0x70
#define SRCH_ON 0x80
/* I/O Control */
#define IOC_HRD_MUTE 0x03
#define IOC_SFT_MUTE 0x01
#define IOC_MON_STR 0x01
#define IOC_SIG_BLND 0x01
#define IOC_INTF_BLND 0x01
#define IOC_ANTENNA 0x01
/* RDS Control */
#define RDS_ON 0x01
#define RDS_BUF_SZ 100
/* Search direction */
#define SRCH_DIR_UP (0)
#define SRCH_DIR_DOWN (1)
/*Search RDS stations*/
#define SEARCH_RDS_STNS_MODE_OFFSET 4
/*Search Station list */
#define PARAMS_PER_STATION 0x07
#define STN_NUM_OFFSET 0x01
#define STN_FREQ_OFFSET 0x02
#define KHZ_TO_MHZ 1000
#define GET_MSB(x)((x >> 8) & 0xFF)
#define GET_LSB(x)((x) & 0xFF)
/* control options */
#define CTRL_ON (1)
#define CTRL_OFF (0)
int hci_def_data_read(struct hci_fm_def_data_rd_req *arg,
struct radio_hci_dev *hdev);
int hci_def_data_write(struct hci_fm_def_data_wr_req *arg,
struct radio_hci_dev *hdev);
int hci_fm_do_calibration(__u8 *arg, struct radio_hci_dev *hdev);
int hci_fm_do_calibration(__u8 *arg, struct radio_hci_dev *hdev);
int hci_peek_data(struct hci_fm_peek_req *arg, struct radio_hci_dev *hdev);
int hci_poke_data(struct hci_fm_poke_req *arg, struct radio_hci_dev *hdev);
int hci_poke_data(struct hci_fm_poke_req *arg, struct radio_hci_dev *hdev);
int hci_poke_data(struct hci_fm_poke_req *arg, struct radio_hci_dev *hdev);
#endif /* __RADIO_HCI_CORE_H */