2011-09-18 16:19:35 +08:00
|
|
|
/*
|
|
|
|
|
* The NFC Controller Interface is the communication protocol between an
|
|
|
|
|
* NFC Controller (NFCC) and a Device Host (DH).
|
|
|
|
|
*
|
|
|
|
|
* Copyright (C) 2011 Texas Instruments, Inc.
|
2013-05-29 21:35:02 +08:00
|
|
|
* Copyright (C) 2013 Intel Corporation. All rights reserved.
|
2014-10-21 22:52:46 +08:00
|
|
|
* Copyright (C) 2014 Marvell International Ltd.
|
2011-09-18 16:19:35 +08:00
|
|
|
*
|
|
|
|
|
* Written by Ilan Elias <ilane@ti.com>
|
|
|
|
|
*
|
|
|
|
|
* Acknowledgements:
|
|
|
|
|
* This file is based on hci_core.h, which was written
|
|
|
|
|
* by Maxim Krasnyansky.
|
|
|
|
|
*
|
|
|
|
|
* 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
|
|
|
|
|
*
|
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
|
*
|
|
|
|
|
* You should have received a copy of the GNU General Public License
|
2013-12-07 01:13:40 +08:00
|
|
|
* along with this program; if not, see <http://www.gnu.org/licenses/>.
|
2011-09-18 16:19:35 +08:00
|
|
|
*
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#ifndef __NCI_CORE_H
|
|
|
|
|
#define __NCI_CORE_H
|
|
|
|
|
|
|
|
|
|
#include <linux/interrupt.h>
|
|
|
|
|
#include <linux/skbuff.h>
|
|
|
|
|
|
|
|
|
|
#include <net/nfc/nfc.h>
|
|
|
|
|
#include <net/nfc/nci.h>
|
|
|
|
|
|
2012-01-18 19:16:12 +08:00
|
|
|
/* NCI device flags */
|
|
|
|
|
enum nci_flag {
|
2011-09-18 16:19:35 +08:00
|
|
|
NCI_INIT,
|
|
|
|
|
NCI_UP,
|
2011-09-22 16:36:19 +08:00
|
|
|
NCI_DATA_EXCHANGE,
|
2012-01-17 18:03:50 +08:00
|
|
|
NCI_DATA_EXCHANGE_TO,
|
2011-09-18 16:19:35 +08:00
|
|
|
};
|
|
|
|
|
|
2012-01-18 19:16:12 +08:00
|
|
|
/* NCI device states */
|
|
|
|
|
enum nci_state {
|
|
|
|
|
NCI_IDLE,
|
|
|
|
|
NCI_DISCOVERY,
|
2012-01-18 19:16:14 +08:00
|
|
|
NCI_W4_ALL_DISCOVERIES,
|
|
|
|
|
NCI_W4_HOST_SELECT,
|
2012-01-18 19:16:12 +08:00
|
|
|
NCI_POLL_ACTIVE,
|
2014-10-21 22:52:46 +08:00
|
|
|
NCI_LISTEN_ACTIVE,
|
|
|
|
|
NCI_LISTEN_SLEEP,
|
2012-01-18 19:16:12 +08:00
|
|
|
};
|
|
|
|
|
|
2011-09-18 16:19:35 +08:00
|
|
|
/* NCI timeouts */
|
|
|
|
|
#define NCI_RESET_TIMEOUT 5000
|
|
|
|
|
#define NCI_INIT_TIMEOUT 5000
|
2012-08-15 16:46:22 +08:00
|
|
|
#define NCI_SET_CONFIG_TIMEOUT 5000
|
2011-09-18 16:19:35 +08:00
|
|
|
#define NCI_RF_DISC_TIMEOUT 5000
|
2012-01-18 19:16:14 +08:00
|
|
|
#define NCI_RF_DISC_SELECT_TIMEOUT 5000
|
2012-01-08 19:43:02 +08:00
|
|
|
#define NCI_RF_DEACTIVATE_TIMEOUT 30000
|
2011-09-18 16:19:35 +08:00
|
|
|
#define NCI_CMD_TIMEOUT 5000
|
2012-01-17 18:03:50 +08:00
|
|
|
#define NCI_DATA_TIMEOUT 700
|
2011-09-18 16:19:35 +08:00
|
|
|
|
|
|
|
|
struct nci_dev;
|
|
|
|
|
|
|
|
|
|
struct nci_ops {
|
2014-09-13 16:28:49 +08:00
|
|
|
int (*open)(struct nci_dev *ndev);
|
|
|
|
|
int (*close)(struct nci_dev *ndev);
|
|
|
|
|
int (*send)(struct nci_dev *ndev, struct sk_buff *skb);
|
|
|
|
|
int (*setup)(struct nci_dev *ndev);
|
2015-03-09 18:12:03 +08:00
|
|
|
int (*fw_download)(struct nci_dev *ndev, const char *firmware_name);
|
2014-09-13 16:28:49 +08:00
|
|
|
__u32 (*get_rfprotocol)(struct nci_dev *ndev, __u8 rf_protocol);
|
2014-11-13 07:30:35 +08:00
|
|
|
int (*discover_se)(struct nci_dev *ndev);
|
2014-11-13 07:30:37 +08:00
|
|
|
int (*disable_se)(struct nci_dev *ndev, u32 se_idx);
|
2014-11-13 07:30:36 +08:00
|
|
|
int (*enable_se)(struct nci_dev *ndev, u32 se_idx);
|
2014-11-13 07:30:38 +08:00
|
|
|
int (*se_io)(struct nci_dev *ndev, u32 se_idx,
|
|
|
|
|
u8 *apdu, size_t apdu_length,
|
|
|
|
|
se_io_cb_t cb, void *cb_context);
|
2015-02-02 05:26:14 +08:00
|
|
|
int (*hci_load_session)(struct nci_dev *ndev);
|
|
|
|
|
void (*hci_event_received)(struct nci_dev *ndev, u8 pipe, u8 event,
|
|
|
|
|
struct sk_buff *skb);
|
|
|
|
|
void (*hci_cmd_received)(struct nci_dev *ndev, u8 pipe, u8 cmd,
|
|
|
|
|
struct sk_buff *skb);
|
2011-09-18 16:19:35 +08:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
#define NCI_MAX_SUPPORTED_RF_INTERFACES 4
|
2012-01-18 19:16:14 +08:00
|
|
|
#define NCI_MAX_DISCOVERED_TARGETS 10
|
2015-02-02 05:26:08 +08:00
|
|
|
#define NCI_MAX_NUM_NFCEE 255
|
|
|
|
|
#define NCI_MAX_CONN_ID 7
|
|
|
|
|
|
|
|
|
|
struct nci_conn_info {
|
|
|
|
|
struct list_head list;
|
|
|
|
|
__u8 id; /* can be an RF Discovery ID or an NFCEE ID */
|
|
|
|
|
__u8 conn_id;
|
|
|
|
|
__u8 max_pkt_payload_len;
|
|
|
|
|
|
|
|
|
|
atomic_t credits_cnt;
|
|
|
|
|
__u8 initial_num_credits;
|
|
|
|
|
|
|
|
|
|
data_exchange_cb_t data_exchange_cb;
|
|
|
|
|
void *data_exchange_cb_context;
|
|
|
|
|
|
|
|
|
|
struct sk_buff *rx_skb;
|
|
|
|
|
};
|
2011-09-18 16:19:35 +08:00
|
|
|
|
2015-02-02 05:26:10 +08:00
|
|
|
#define NCI_INVALID_CONN_ID 0x80
|
|
|
|
|
|
2015-02-02 05:26:14 +08:00
|
|
|
#define NCI_HCI_ANY_OPEN_PIPE 0x03
|
|
|
|
|
|
|
|
|
|
/* Gates */
|
|
|
|
|
#define NCI_HCI_ADMIN_GATE 0x00
|
|
|
|
|
#define NCI_HCI_LINK_MGMT_GATE 0x06
|
|
|
|
|
|
|
|
|
|
/* Pipes */
|
|
|
|
|
#define NCI_HCI_LINK_MGMT_PIPE 0x00
|
|
|
|
|
#define NCI_HCI_ADMIN_PIPE 0x01
|
|
|
|
|
|
|
|
|
|
/* Generic responses */
|
|
|
|
|
#define NCI_HCI_ANY_OK 0x00
|
|
|
|
|
#define NCI_HCI_ANY_E_NOT_CONNECTED 0x01
|
|
|
|
|
#define NCI_HCI_ANY_E_CMD_PAR_UNKNOWN 0x02
|
|
|
|
|
#define NCI_HCI_ANY_E_NOK 0x03
|
|
|
|
|
#define NCI_HCI_ANY_E_PIPES_FULL 0x04
|
|
|
|
|
#define NCI_HCI_ANY_E_REG_PAR_UNKNOWN 0x05
|
|
|
|
|
#define NCI_HCI_ANY_E_PIPE_NOT_OPENED 0x06
|
|
|
|
|
#define NCI_HCI_ANY_E_CMD_NOT_SUPPORTED 0x07
|
|
|
|
|
#define NCI_HCI_ANY_E_INHIBITED 0x08
|
|
|
|
|
#define NCI_HCI_ANY_E_TIMEOUT 0x09
|
|
|
|
|
#define NCI_HCI_ANY_E_REG_ACCESS_DENIED 0x0a
|
|
|
|
|
#define NCI_HCI_ANY_E_PIPE_ACCESS_DENIED 0x0b
|
|
|
|
|
|
|
|
|
|
#define NCI_HCI_DO_NOT_OPEN_PIPE 0x81
|
|
|
|
|
#define NCI_HCI_INVALID_PIPE 0x80
|
|
|
|
|
#define NCI_HCI_INVALID_GATE 0xFF
|
|
|
|
|
#define NCI_HCI_INVALID_HOST 0x80
|
|
|
|
|
|
|
|
|
|
#define NCI_HCI_MAX_CUSTOM_GATES 50
|
2015-03-31 14:02:21 +08:00
|
|
|
/*
|
|
|
|
|
* According to specification 102 622 chapter 4.4 Pipes,
|
|
|
|
|
* the pipe identifier is 7 bits long.
|
|
|
|
|
*/
|
2015-02-02 05:26:14 +08:00
|
|
|
#define NCI_HCI_MAX_PIPES 127
|
|
|
|
|
|
|
|
|
|
struct nci_hci_gate {
|
|
|
|
|
u8 gate;
|
|
|
|
|
u8 pipe;
|
|
|
|
|
u8 dest_host;
|
|
|
|
|
} __packed;
|
|
|
|
|
|
|
|
|
|
struct nci_hci_pipe {
|
|
|
|
|
u8 gate;
|
|
|
|
|
u8 host;
|
|
|
|
|
} __packed;
|
|
|
|
|
|
|
|
|
|
struct nci_hci_init_data {
|
|
|
|
|
u8 gate_count;
|
|
|
|
|
struct nci_hci_gate gates[NCI_HCI_MAX_CUSTOM_GATES];
|
|
|
|
|
char session_id[9];
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
#define NCI_HCI_MAX_GATES 256
|
|
|
|
|
|
|
|
|
|
struct nci_hci_dev {
|
2015-02-04 02:48:07 +08:00
|
|
|
u8 nfcee_id;
|
2015-02-02 05:26:14 +08:00
|
|
|
struct nci_dev *ndev;
|
|
|
|
|
struct nci_conn_info *conn_info;
|
|
|
|
|
|
|
|
|
|
struct nci_hci_init_data init_data;
|
|
|
|
|
struct nci_hci_pipe pipes[NCI_HCI_MAX_PIPES];
|
|
|
|
|
u8 gate2pipe[NCI_HCI_MAX_GATES];
|
|
|
|
|
int expected_pipes;
|
|
|
|
|
int count_pipes;
|
|
|
|
|
|
|
|
|
|
struct sk_buff_head rx_hcp_frags;
|
|
|
|
|
struct work_struct msg_rx_work;
|
|
|
|
|
struct sk_buff_head msg_rx_queue;
|
|
|
|
|
};
|
|
|
|
|
|
2011-09-18 16:19:35 +08:00
|
|
|
/* NCI Core structures */
|
|
|
|
|
struct nci_dev {
|
|
|
|
|
struct nfc_dev *nfc_dev;
|
|
|
|
|
struct nci_ops *ops;
|
2015-02-02 05:26:14 +08:00
|
|
|
struct nci_hci_dev *hci_dev;
|
2011-09-18 16:19:35 +08:00
|
|
|
|
|
|
|
|
int tx_headroom;
|
|
|
|
|
int tx_tailroom;
|
|
|
|
|
|
2012-01-18 19:16:12 +08:00
|
|
|
atomic_t state;
|
2011-09-18 16:19:35 +08:00
|
|
|
unsigned long flags;
|
|
|
|
|
|
|
|
|
|
atomic_t cmd_cnt;
|
2015-02-02 05:26:08 +08:00
|
|
|
__u8 cur_conn_id;
|
|
|
|
|
|
|
|
|
|
struct list_head conn_info_list;
|
2015-02-04 02:48:04 +08:00
|
|
|
struct nci_conn_info *rf_conn_info;
|
2011-09-18 16:19:35 +08:00
|
|
|
|
|
|
|
|
struct timer_list cmd_timer;
|
2012-01-17 18:03:50 +08:00
|
|
|
struct timer_list data_timer;
|
2011-09-18 16:19:35 +08:00
|
|
|
|
|
|
|
|
struct workqueue_struct *cmd_wq;
|
|
|
|
|
struct work_struct cmd_work;
|
|
|
|
|
|
|
|
|
|
struct workqueue_struct *rx_wq;
|
|
|
|
|
struct work_struct rx_work;
|
|
|
|
|
|
|
|
|
|
struct workqueue_struct *tx_wq;
|
|
|
|
|
struct work_struct tx_work;
|
|
|
|
|
|
|
|
|
|
struct sk_buff_head cmd_q;
|
|
|
|
|
struct sk_buff_head rx_q;
|
|
|
|
|
struct sk_buff_head tx_q;
|
|
|
|
|
|
|
|
|
|
struct mutex req_lock;
|
|
|
|
|
struct completion req_completion;
|
|
|
|
|
__u32 req_status;
|
|
|
|
|
__u32 req_result;
|
|
|
|
|
|
|
|
|
|
void *driver_data;
|
|
|
|
|
|
|
|
|
|
__u32 poll_prots;
|
|
|
|
|
__u32 target_active_prot;
|
|
|
|
|
|
2012-01-18 19:16:14 +08:00
|
|
|
struct nfc_target targets[NCI_MAX_DISCOVERED_TARGETS];
|
|
|
|
|
int n_targets;
|
|
|
|
|
|
2011-09-18 16:19:35 +08:00
|
|
|
/* received during NCI_OP_CORE_RESET_RSP */
|
|
|
|
|
__u8 nci_ver;
|
|
|
|
|
|
|
|
|
|
/* received during NCI_OP_CORE_INIT_RSP */
|
|
|
|
|
__u32 nfcc_features;
|
|
|
|
|
__u8 num_supported_rf_interfaces;
|
|
|
|
|
__u8 supported_rf_interfaces
|
|
|
|
|
[NCI_MAX_SUPPORTED_RF_INTERFACES];
|
|
|
|
|
__u8 max_logical_connections;
|
|
|
|
|
__u16 max_routing_table_size;
|
2011-11-09 18:09:14 +08:00
|
|
|
__u8 max_ctrl_pkt_payload_len;
|
|
|
|
|
__u16 max_size_for_large_params;
|
|
|
|
|
__u8 manufact_id;
|
|
|
|
|
__u32 manufact_specific_info;
|
2011-09-18 16:19:35 +08:00
|
|
|
|
2015-02-02 05:26:08 +08:00
|
|
|
/* Save RF Discovery ID or NFCEE ID under conn_create */
|
|
|
|
|
__u8 cur_id;
|
2011-12-20 22:57:40 +08:00
|
|
|
|
2011-09-18 16:19:35 +08:00
|
|
|
/* stored during nci_data_exchange */
|
|
|
|
|
struct sk_buff *rx_data_reassembly;
|
2012-08-15 16:46:24 +08:00
|
|
|
|
|
|
|
|
/* stored during intf_activated_ntf */
|
|
|
|
|
__u8 remote_gb[NFC_MAX_GT_LEN];
|
|
|
|
|
__u8 remote_gb_len;
|
2011-09-18 16:19:35 +08:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/* ----- NCI Devices ----- */
|
|
|
|
|
struct nci_dev *nci_allocate_device(struct nci_ops *ops,
|
2012-03-05 08:03:54 +08:00
|
|
|
__u32 supported_protocols,
|
|
|
|
|
int tx_headroom,
|
|
|
|
|
int tx_tailroom);
|
2011-09-18 16:19:35 +08:00
|
|
|
void nci_free_device(struct nci_dev *ndev);
|
|
|
|
|
int nci_register_device(struct nci_dev *ndev);
|
|
|
|
|
void nci_unregister_device(struct nci_dev *ndev);
|
2015-02-02 05:26:14 +08:00
|
|
|
int nci_request(struct nci_dev *ndev,
|
|
|
|
|
void (*req)(struct nci_dev *ndev,
|
|
|
|
|
unsigned long opt),
|
|
|
|
|
unsigned long opt, __u32 timeout);
|
2013-05-22 17:36:17 +08:00
|
|
|
int nci_recv_frame(struct nci_dev *ndev, struct sk_buff *skb);
|
2014-01-07 04:58:18 +08:00
|
|
|
int nci_set_config(struct nci_dev *ndev, __u8 id, size_t len, __u8 *val);
|
2011-09-18 16:19:35 +08:00
|
|
|
|
2015-02-02 05:26:10 +08:00
|
|
|
int nci_nfcee_discover(struct nci_dev *ndev, u8 action);
|
2015-02-02 05:26:11 +08:00
|
|
|
int nci_nfcee_mode_set(struct nci_dev *ndev, u8 nfcee_id, u8 nfcee_mode);
|
2015-02-04 02:48:05 +08:00
|
|
|
int nci_core_conn_create(struct nci_dev *ndev, u8 destination_type,
|
|
|
|
|
u8 number_destination_params,
|
|
|
|
|
size_t params_len,
|
2015-02-02 05:26:12 +08:00
|
|
|
struct core_conn_create_dest_spec_params *params);
|
|
|
|
|
int nci_core_conn_close(struct nci_dev *ndev, u8 conn_id);
|
2015-02-02 05:26:10 +08:00
|
|
|
|
2015-02-02 05:26:14 +08:00
|
|
|
struct nci_hci_dev *nci_hci_allocate(struct nci_dev *ndev);
|
|
|
|
|
int nci_hci_send_event(struct nci_dev *ndev, u8 gate, u8 event,
|
|
|
|
|
const u8 *param, size_t param_len);
|
|
|
|
|
int nci_hci_send_cmd(struct nci_dev *ndev, u8 gate,
|
|
|
|
|
u8 cmd, const u8 *param, size_t param_len,
|
|
|
|
|
struct sk_buff **skb);
|
|
|
|
|
int nci_hci_open_pipe(struct nci_dev *ndev, u8 pipe);
|
|
|
|
|
int nci_hci_connect_gate(struct nci_dev *ndev, u8 dest_host,
|
|
|
|
|
u8 dest_gate, u8 pipe);
|
|
|
|
|
int nci_hci_set_param(struct nci_dev *ndev, u8 gate, u8 idx,
|
|
|
|
|
const u8 *param, size_t param_len);
|
|
|
|
|
int nci_hci_get_param(struct nci_dev *ndev, u8 gate, u8 idx,
|
|
|
|
|
struct sk_buff **skb);
|
|
|
|
|
int nci_hci_dev_session_init(struct nci_dev *ndev);
|
|
|
|
|
|
2011-09-18 16:19:35 +08:00
|
|
|
static inline struct sk_buff *nci_skb_alloc(struct nci_dev *ndev,
|
2012-03-05 08:03:54 +08:00
|
|
|
unsigned int len,
|
|
|
|
|
gfp_t how)
|
2011-09-18 16:19:35 +08:00
|
|
|
{
|
|
|
|
|
struct sk_buff *skb;
|
|
|
|
|
|
|
|
|
|
skb = alloc_skb(len + ndev->tx_headroom + ndev->tx_tailroom, how);
|
|
|
|
|
if (skb)
|
|
|
|
|
skb_reserve(skb, ndev->tx_headroom);
|
|
|
|
|
|
|
|
|
|
return skb;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static inline void nci_set_parent_dev(struct nci_dev *ndev, struct device *dev)
|
|
|
|
|
{
|
|
|
|
|
nfc_set_parent_dev(ndev->nfc_dev, dev);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static inline void nci_set_drvdata(struct nci_dev *ndev, void *data)
|
|
|
|
|
{
|
|
|
|
|
ndev->driver_data = data;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static inline void *nci_get_drvdata(struct nci_dev *ndev)
|
|
|
|
|
{
|
|
|
|
|
return ndev->driver_data;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
void nci_rsp_packet(struct nci_dev *ndev, struct sk_buff *skb);
|
|
|
|
|
void nci_ntf_packet(struct nci_dev *ndev, struct sk_buff *skb);
|
|
|
|
|
void nci_rx_data_packet(struct nci_dev *ndev, struct sk_buff *skb);
|
|
|
|
|
int nci_send_cmd(struct nci_dev *ndev, __u16 opcode, __u8 plen, void *payload);
|
|
|
|
|
int nci_send_data(struct nci_dev *ndev, __u8 conn_id, struct sk_buff *skb);
|
|
|
|
|
void nci_data_exchange_complete(struct nci_dev *ndev, struct sk_buff *skb,
|
2015-02-02 05:26:08 +08:00
|
|
|
__u8 conn_id, int err);
|
2015-02-02 05:26:14 +08:00
|
|
|
void nci_hci_data_received_cb(void *context, struct sk_buff *skb, int err);
|
|
|
|
|
|
2012-01-18 19:16:14 +08:00
|
|
|
void nci_clear_target_list(struct nci_dev *ndev);
|
2011-09-18 16:19:35 +08:00
|
|
|
|
|
|
|
|
/* ----- NCI requests ----- */
|
|
|
|
|
#define NCI_REQ_DONE 0
|
|
|
|
|
#define NCI_REQ_PEND 1
|
|
|
|
|
#define NCI_REQ_CANCELED 2
|
|
|
|
|
|
|
|
|
|
void nci_req_complete(struct nci_dev *ndev, int result);
|
2015-02-02 05:26:08 +08:00
|
|
|
struct nci_conn_info *nci_get_conn_info_by_conn_id(struct nci_dev *ndev,
|
|
|
|
|
int conn_id);
|
2011-09-18 16:19:35 +08:00
|
|
|
|
|
|
|
|
/* ----- NCI status code ----- */
|
|
|
|
|
int nci_to_errno(__u8 code);
|
|
|
|
|
|
2013-05-29 21:35:02 +08:00
|
|
|
/* ----- NCI over SPI acknowledge modes ----- */
|
|
|
|
|
#define NCI_SPI_CRC_DISABLED 0x00
|
|
|
|
|
#define NCI_SPI_CRC_ENABLED 0x01
|
|
|
|
|
|
|
|
|
|
/* ----- NCI SPI structures ----- */
|
2013-09-05 17:02:21 +08:00
|
|
|
struct nci_spi {
|
2013-09-02 18:35:39 +08:00
|
|
|
struct nci_dev *ndev;
|
2013-05-29 21:35:02 +08:00
|
|
|
struct spi_device *spi;
|
|
|
|
|
|
|
|
|
|
unsigned int xfer_udelay; /* microseconds delay between
|
|
|
|
|
transactions */
|
|
|
|
|
u8 acknowledge_mode;
|
|
|
|
|
|
2013-05-29 21:35:03 +08:00
|
|
|
struct completion req_completion;
|
|
|
|
|
u8 req_result;
|
2013-05-29 21:35:02 +08:00
|
|
|
};
|
|
|
|
|
|
2013-09-05 17:02:21 +08:00
|
|
|
/* ----- NCI SPI ----- */
|
|
|
|
|
struct nci_spi *nci_spi_allocate_spi(struct spi_device *spi,
|
|
|
|
|
u8 acknowledge_mode, unsigned int delay,
|
|
|
|
|
struct nci_dev *ndev);
|
NFC: NCI: Modify NCI SPI to implement CS/INT handshake per the spec
The NFC Forum NCI specification defines both a hardware and software
protocol when using a SPI physical transport to connect an NFC NCI
Chipset. The hardware requirement is that, after having raised the chip
select line, the SPI driver must wait for an INT line from the NFC
chipset to raise before it sends the data. The chip select must be
raised first though, because this is the signal that the NFC chipset
will detect to wake up and then raise its INT line. If the INT line
doesn't raise in a timely fashion, the SPI driver should abort
operation.
When data is transferred from Device host (DH) to NFC Controller (NFCC),
the signaling sequence is the following:
Data Transfer from DH to NFCC
• 1-Master asserts SPI_CSN
• 2-Slave asserts SPI_INT
• 3-Master sends NCI-over-SPI protocol header and payload data
• 4-Slave deasserts SPI_INT
• 5-Master deasserts SPI_CSN
When data must be transferred from NFCC to DH, things are a little bit
different.
Data Transfer from NFCC to DH
• 1-Slave asserts SPI_INT -> NFC chipset irq handler called -> process
reading from SPI
• 2-Master asserts SPI_CSN
• 3-Master send 2-octet NCI-over-SPI protocol header
• 4-Slave sends 2-octet NCI-over-SPI protocol payload length
• 5-Slave sends NCI-over-SPI protocol payload
• 6-Master deasserts SPI_CSN
In this case, SPI driver should function normally as it does today. Note
that the INT line can and will be lowered anytime between beginning of
step 3 and end of step 5. A low INT is therefore valid after chip select
has been raised.
This would be easily implemented in a single driver. Unfortunately, we
don't write the SPI driver and I had to imagine some workaround trick to
get the SPI and NFC drivers to work in a synchronized fashion. The trick
is the following:
- send an empty spi message: this will raise the chip select line, and
send nothing. We expect the /CS line will stay arisen because we asked
for it in the spi_transfer cs_change field
- wait for a completion, that will be completed by the NFC driver IRQ
handler when it knows we are in the process of sending data (NFC spec
says that we use SPI in a half duplex mode, so we are either sending or
receiving).
- when completed, proceed with the normal data send.
This has been tested and verified to work very consistently on a Nexus
10 (spi-s3c64xx driver). It may not work the same with other spi
drivers.
The previously defined nci_spi_ops{} whose intended purpose were to
address this problem are not used anymore and therefore totally removed.
The nci_spi_send() takes a new optional write_handshake_completion
completion pointer. If non NULL, the nci spi layer will run the above
trick when sending data to the NFC Chip. If NULL, the data is sent
normally all at once and it is then the NFC driver responsibility to
know what it's doing.
Signed-off-by: Eric Lapuyade <eric.lapuyade@intel.com>
Signed-off-by: Samuel Ortiz <sameo@linux.intel.com>
2013-09-23 23:56:43 +08:00
|
|
|
int nci_spi_send(struct nci_spi *nspi,
|
|
|
|
|
struct completion *write_handshake_completion,
|
|
|
|
|
struct sk_buff *skb);
|
2013-09-23 23:56:31 +08:00
|
|
|
struct sk_buff *nci_spi_read(struct nci_spi *nspi);
|
2013-05-29 21:35:02 +08:00
|
|
|
|
2011-09-18 16:19:35 +08:00
|
|
|
#endif /* __NCI_CORE_H */
|