2011-07-02 06:31:33 +08:00
|
|
|
/*
|
|
|
|
* Copyright (C) 2011 Instituto Nokia de Tecnologia
|
2014-10-21 22:52:46 +08:00
|
|
|
* Copyright (C) 2014 Marvell International Ltd.
|
2011-07-02 06:31:33 +08:00
|
|
|
*
|
|
|
|
* Authors:
|
|
|
|
* Lauro Ramos Venancio <lauro.venancio@openbossa.org>
|
|
|
|
* Aloisio Almeida Jr <aloisio.almeida@openbossa.org>
|
|
|
|
*
|
|
|
|
* This program is free software; you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU General Public License as published by
|
|
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
|
|
* (at your option) any later version.
|
|
|
|
*
|
|
|
|
* 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-07-02 06:31:33 +08:00
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef __NET_NFC_H
|
|
|
|
#define __NET_NFC_H
|
|
|
|
|
2012-01-17 17:06:43 +08:00
|
|
|
#include <linux/nfc.h>
|
2011-07-02 06:31:33 +08:00
|
|
|
#include <linux/device.h>
|
|
|
|
#include <linux/skbuff.h>
|
|
|
|
|
2013-04-06 03:27:38 +08:00
|
|
|
#define nfc_info(dev, fmt, ...) dev_info((dev), "NFC: " fmt, ##__VA_ARGS__)
|
|
|
|
#define nfc_err(dev, fmt, ...) dev_err((dev), "NFC: " fmt, ##__VA_ARGS__)
|
2011-07-02 06:31:33 +08:00
|
|
|
|
2013-09-03 17:51:00 +08:00
|
|
|
struct nfc_phy_ops {
|
|
|
|
int (*write)(void *dev_id, struct sk_buff *skb);
|
|
|
|
int (*enable)(void *dev_id);
|
|
|
|
void (*disable)(void *dev_id);
|
|
|
|
};
|
|
|
|
|
2011-07-02 06:31:33 +08:00
|
|
|
struct nfc_dev;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* data_exchange_cb_t - Definition of nfc_data_exchange callback
|
|
|
|
*
|
|
|
|
* @context: nfc_data_exchange cb_context parameter
|
|
|
|
* @skb: response data
|
|
|
|
* @err: If an error has occurred during data exchange, it is the
|
|
|
|
* error number. Zero means no error.
|
|
|
|
*
|
|
|
|
* When a rx or tx package is lost or corrupted or the target gets out
|
|
|
|
* of the operating field, err is -EIO.
|
|
|
|
*/
|
|
|
|
typedef void (*data_exchange_cb_t)(void *context, struct sk_buff *skb,
|
|
|
|
int err);
|
|
|
|
|
2013-08-28 06:39:48 +08:00
|
|
|
typedef void (*se_io_cb_t)(void *context, u8 *apdu, size_t apdu_len, int err);
|
|
|
|
|
2012-05-07 18:31:13 +08:00
|
|
|
struct nfc_target;
|
|
|
|
|
2011-07-02 06:31:33 +08:00
|
|
|
struct nfc_ops {
|
2011-09-18 16:19:33 +08:00
|
|
|
int (*dev_up)(struct nfc_dev *dev);
|
|
|
|
int (*dev_down)(struct nfc_dev *dev);
|
2012-05-15 21:57:06 +08:00
|
|
|
int (*start_poll)(struct nfc_dev *dev,
|
|
|
|
u32 im_protocols, u32 tm_protocols);
|
2011-07-02 06:31:33 +08:00
|
|
|
void (*stop_poll)(struct nfc_dev *dev);
|
2012-05-07 18:31:13 +08:00
|
|
|
int (*dep_link_up)(struct nfc_dev *dev, struct nfc_target *target,
|
|
|
|
u8 comm_mode, u8 *gb, size_t gb_len);
|
2011-12-14 23:43:09 +08:00
|
|
|
int (*dep_link_down)(struct nfc_dev *dev);
|
2012-05-07 18:31:13 +08:00
|
|
|
int (*activate_target)(struct nfc_dev *dev, struct nfc_target *target,
|
2012-03-05 08:03:53 +08:00
|
|
|
u32 protocol);
|
2012-05-07 18:31:13 +08:00
|
|
|
void (*deactivate_target)(struct nfc_dev *dev,
|
|
|
|
struct nfc_target *target);
|
2012-05-16 21:55:48 +08:00
|
|
|
int (*im_transceive)(struct nfc_dev *dev, struct nfc_target *target,
|
2012-03-05 08:03:53 +08:00
|
|
|
struct sk_buff *skb, data_exchange_cb_t cb,
|
|
|
|
void *cb_context);
|
2012-05-16 21:55:48 +08:00
|
|
|
int (*tm_send)(struct nfc_dev *dev, struct sk_buff *skb);
|
2012-05-07 18:31:13 +08:00
|
|
|
int (*check_presence)(struct nfc_dev *dev, struct nfc_target *target);
|
2013-07-31 07:19:43 +08:00
|
|
|
int (*fw_download)(struct nfc_dev *dev, const char *firmware_name);
|
2013-05-10 17:57:06 +08:00
|
|
|
|
|
|
|
/* Secure Element API */
|
|
|
|
int (*discover_se)(struct nfc_dev *dev);
|
|
|
|
int (*enable_se)(struct nfc_dev *dev, u32 se_idx);
|
|
|
|
int (*disable_se)(struct nfc_dev *dev, u32 se_idx);
|
2013-08-28 06:39:48 +08:00
|
|
|
int (*se_io) (struct nfc_dev *dev, u32 se_idx,
|
|
|
|
u8 *apdu, size_t apdu_length,
|
|
|
|
se_io_cb_t cb, void *cb_context);
|
2011-07-02 06:31:33 +08:00
|
|
|
};
|
|
|
|
|
2011-12-14 23:43:09 +08:00
|
|
|
#define NFC_TARGET_IDX_ANY -1
|
|
|
|
#define NFC_MAX_GT_LEN 48
|
2012-08-15 16:46:24 +08:00
|
|
|
#define NFC_ATR_RES_GT_OFFSET 15
|
2014-10-21 22:52:46 +08:00
|
|
|
#define NFC_ATR_REQ_GT_OFFSET 14
|
2011-12-14 23:43:09 +08:00
|
|
|
|
2013-09-24 18:40:44 +08:00
|
|
|
/**
|
|
|
|
* struct nfc_target - NFC target descriptiom
|
|
|
|
*
|
|
|
|
* @sens_res: 2 bytes describing the target SENS_RES response, if the target
|
|
|
|
* is a type A one. The %sens_res most significant byte must be byte 2
|
|
|
|
* as described by the NFC Forum digital specification (i.e. the platform
|
|
|
|
* configuration one) while %sens_res least significant byte is byte 1.
|
|
|
|
*/
|
2011-07-02 06:31:34 +08:00
|
|
|
struct nfc_target {
|
|
|
|
u32 idx;
|
|
|
|
u32 supported_protocols;
|
|
|
|
u16 sens_res;
|
|
|
|
u8 sel_res;
|
2011-12-22 17:51:54 +08:00
|
|
|
u8 nfcid1_len;
|
2012-01-17 17:06:43 +08:00
|
|
|
u8 nfcid1[NFC_NFCID1_MAXSIZE];
|
2013-05-27 21:29:11 +08:00
|
|
|
u8 nfcid2_len;
|
|
|
|
u8 nfcid2[NFC_NFCID2_MAXSIZE];
|
2012-01-17 17:06:43 +08:00
|
|
|
u8 sensb_res_len;
|
|
|
|
u8 sensb_res[NFC_SENSB_RES_MAXSIZE];
|
|
|
|
u8 sensf_res_len;
|
|
|
|
u8 sensf_res[NFC_SENSF_RES_MAXSIZE];
|
2012-04-11 01:43:06 +08:00
|
|
|
u8 hci_reader_gate;
|
2012-04-11 01:43:09 +08:00
|
|
|
u8 logical_idx;
|
2014-01-15 08:52:09 +08:00
|
|
|
u8 is_iso15693;
|
|
|
|
u8 iso15693_dsfid;
|
|
|
|
u8 iso15693_uid[NFC_ISO15693_UID_MAXSIZE];
|
2011-07-02 06:31:34 +08:00
|
|
|
};
|
|
|
|
|
2013-05-10 21:28:38 +08:00
|
|
|
/**
|
|
|
|
* nfc_se - A structure for NFC accessible secure elements.
|
|
|
|
*
|
|
|
|
* @idx: The secure element index. User space will enable or
|
|
|
|
* disable a secure element by its index.
|
|
|
|
* @type: The secure element type. It can be SE_UICC or
|
|
|
|
* SE_EMBEDDED.
|
|
|
|
* @state: The secure element state, either enabled or disabled.
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
struct nfc_se {
|
|
|
|
struct list_head list;
|
|
|
|
u32 idx;
|
|
|
|
u16 type;
|
|
|
|
u16 state;
|
|
|
|
};
|
|
|
|
|
2015-02-02 05:26:16 +08:00
|
|
|
/**
|
|
|
|
* nfc_evt_transaction - A struct for NFC secure element event transaction.
|
|
|
|
*
|
|
|
|
* @aid: The application identifier triggering the event
|
|
|
|
*
|
|
|
|
* @aid_len: The application identifier length [5:16]
|
|
|
|
*
|
|
|
|
* @params: The application parameters transmitted during the transaction
|
|
|
|
*
|
|
|
|
* @params_len: The applications parameters length [0:255]
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
#define NFC_MIN_AID_LENGTH 5
|
|
|
|
#define NFC_MAX_AID_LENGTH 16
|
|
|
|
#define NFC_MAX_PARAMS_LENGTH 255
|
|
|
|
|
|
|
|
#define NFC_EVT_TRANSACTION_AID_TAG 0x81
|
|
|
|
#define NFC_EVT_TRANSACTION_PARAMS_TAG 0x82
|
|
|
|
struct nfc_evt_transaction {
|
|
|
|
u32 aid_len;
|
|
|
|
u8 aid[NFC_MAX_AID_LENGTH];
|
|
|
|
u8 params_len;
|
2015-03-31 14:02:19 +08:00
|
|
|
u8 params[0];
|
2015-02-02 05:26:16 +08:00
|
|
|
} __packed;
|
|
|
|
|
2011-07-02 06:31:34 +08:00
|
|
|
struct nfc_genl_data {
|
2012-09-08 04:12:54 +08:00
|
|
|
u32 poll_req_portid;
|
2011-07-02 06:31:34 +08:00
|
|
|
struct mutex genl_data_mutex;
|
|
|
|
};
|
|
|
|
|
2011-07-02 06:31:33 +08:00
|
|
|
struct nfc_dev {
|
2012-10-22 21:57:58 +08:00
|
|
|
int idx;
|
2012-04-11 01:43:10 +08:00
|
|
|
u32 target_next_idx;
|
2011-07-02 06:31:34 +08:00
|
|
|
struct nfc_target *targets;
|
|
|
|
int n_targets;
|
|
|
|
int targets_generation;
|
2011-07-02 06:31:33 +08:00
|
|
|
struct device dev;
|
2011-09-18 16:19:33 +08:00
|
|
|
bool dev_up;
|
2013-07-31 07:19:43 +08:00
|
|
|
bool fw_download_in_progress;
|
2012-05-31 06:02:26 +08:00
|
|
|
u8 rf_mode;
|
2011-07-02 06:31:33 +08:00
|
|
|
bool polling;
|
2012-05-07 18:31:13 +08:00
|
|
|
struct nfc_target *active_target;
|
2011-12-14 23:43:09 +08:00
|
|
|
bool dep_link_up;
|
2011-07-02 06:31:34 +08:00
|
|
|
struct nfc_genl_data genl_data;
|
2011-07-02 06:31:33 +08:00
|
|
|
u32 supported_protocols;
|
|
|
|
|
2013-05-10 21:28:38 +08:00
|
|
|
struct list_head secure_elements;
|
2012-12-20 02:11:32 +08:00
|
|
|
|
2011-08-19 21:47:11 +08:00
|
|
|
int tx_headroom;
|
|
|
|
int tx_tailroom;
|
|
|
|
|
2012-04-11 01:43:12 +08:00
|
|
|
struct timer_list check_pres_timer;
|
|
|
|
struct work_struct check_pres_work;
|
|
|
|
|
2012-11-27 01:06:27 +08:00
|
|
|
bool shutting_down;
|
|
|
|
|
2013-04-11 17:52:20 +08:00
|
|
|
struct rfkill *rfkill;
|
|
|
|
|
2011-07-02 06:31:33 +08:00
|
|
|
struct nfc_ops *ops;
|
|
|
|
};
|
|
|
|
#define to_nfc_dev(_dev) container_of(_dev, struct nfc_dev, dev)
|
|
|
|
|
|
|
|
extern struct class nfc_class;
|
|
|
|
|
|
|
|
struct nfc_dev *nfc_allocate_device(struct nfc_ops *ops,
|
2012-03-05 08:03:53 +08:00
|
|
|
u32 supported_protocols,
|
|
|
|
int tx_headroom,
|
|
|
|
int tx_tailroom);
|
2011-07-02 06:31:33 +08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* nfc_free_device - free nfc device
|
|
|
|
*
|
|
|
|
* @dev: The nfc device to free
|
|
|
|
*/
|
|
|
|
static inline void nfc_free_device(struct nfc_dev *dev)
|
|
|
|
{
|
|
|
|
put_device(&dev->dev);
|
|
|
|
}
|
|
|
|
|
|
|
|
int nfc_register_device(struct nfc_dev *dev);
|
|
|
|
|
|
|
|
void nfc_unregister_device(struct nfc_dev *dev);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* nfc_set_parent_dev - set the parent device
|
|
|
|
*
|
|
|
|
* @nfc_dev: The nfc device whose parent is being set
|
|
|
|
* @dev: The parent device
|
|
|
|
*/
|
|
|
|
static inline void nfc_set_parent_dev(struct nfc_dev *nfc_dev,
|
2012-03-05 08:03:53 +08:00
|
|
|
struct device *dev)
|
2011-07-02 06:31:33 +08:00
|
|
|
{
|
|
|
|
nfc_dev->dev.parent = dev;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* nfc_set_drvdata - set driver specifc data
|
|
|
|
*
|
|
|
|
* @dev: The nfc device
|
|
|
|
* @data: Pointer to driver specifc data
|
|
|
|
*/
|
|
|
|
static inline void nfc_set_drvdata(struct nfc_dev *dev, void *data)
|
|
|
|
{
|
|
|
|
dev_set_drvdata(&dev->dev, data);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* nfc_get_drvdata - get driver specifc data
|
|
|
|
*
|
|
|
|
* @dev: The nfc device
|
|
|
|
*/
|
|
|
|
static inline void *nfc_get_drvdata(struct nfc_dev *dev)
|
|
|
|
{
|
|
|
|
return dev_get_drvdata(&dev->dev);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* nfc_device_name - get the nfc device name
|
|
|
|
*
|
|
|
|
* @dev: The nfc device whose name to return
|
|
|
|
*/
|
|
|
|
static inline const char *nfc_device_name(struct nfc_dev *dev)
|
|
|
|
{
|
|
|
|
return dev_name(&dev->dev);
|
|
|
|
}
|
|
|
|
|
2011-12-14 23:43:06 +08:00
|
|
|
struct sk_buff *nfc_alloc_send_skb(struct nfc_dev *dev, struct sock *sk,
|
2012-03-05 08:03:53 +08:00
|
|
|
unsigned int flags, unsigned int size,
|
|
|
|
unsigned int *err);
|
2011-12-14 23:43:06 +08:00
|
|
|
struct sk_buff *nfc_alloc_recv_skb(unsigned int size, gfp_t gfp);
|
2011-07-02 06:31:33 +08:00
|
|
|
|
2011-12-14 23:43:10 +08:00
|
|
|
int nfc_set_remote_general_bytes(struct nfc_dev *dev,
|
2012-03-05 08:03:53 +08:00
|
|
|
u8 *gt, u8 gt_len);
|
2012-04-10 18:51:52 +08:00
|
|
|
u8 *nfc_get_local_general_bytes(struct nfc_dev *dev, size_t *gb_len);
|
2011-12-14 23:43:10 +08:00
|
|
|
|
2013-07-19 20:57:55 +08:00
|
|
|
int nfc_fw_download_done(struct nfc_dev *dev, const char *firmware_name,
|
|
|
|
u32 result);
|
2013-07-19 20:56:08 +08:00
|
|
|
|
2012-03-05 08:03:53 +08:00
|
|
|
int nfc_targets_found(struct nfc_dev *dev,
|
|
|
|
struct nfc_target *targets, int ntargets);
|
2012-04-11 01:43:05 +08:00
|
|
|
int nfc_target_lost(struct nfc_dev *dev, u32 target_idx);
|
2011-07-02 06:31:34 +08:00
|
|
|
|
2011-12-14 23:43:09 +08:00
|
|
|
int nfc_dep_link_is_up(struct nfc_dev *dev, u32 target_idx,
|
|
|
|
u8 comm_mode, u8 rf_mode);
|
|
|
|
|
2012-06-01 19:21:13 +08:00
|
|
|
int nfc_tm_activated(struct nfc_dev *dev, u32 protocol, u8 comm_mode,
|
|
|
|
u8 *gb, size_t gb_len);
|
|
|
|
int nfc_tm_deactivated(struct nfc_dev *dev);
|
2012-05-31 06:05:50 +08:00
|
|
|
int nfc_tm_data_received(struct nfc_dev *dev, struct sk_buff *skb);
|
2012-06-01 19:21:13 +08:00
|
|
|
|
2012-06-11 19:49:51 +08:00
|
|
|
void nfc_driver_failure(struct nfc_dev *dev, int err);
|
|
|
|
|
2015-02-02 05:26:16 +08:00
|
|
|
int nfc_se_transaction(struct nfc_dev *dev, u8 se_idx,
|
|
|
|
struct nfc_evt_transaction *evt_transaction);
|
2013-05-10 21:28:38 +08:00
|
|
|
int nfc_add_se(struct nfc_dev *dev, u32 se_idx, u16 type);
|
|
|
|
int nfc_remove_se(struct nfc_dev *dev, u32 se_idx);
|
2013-08-23 16:02:08 +08:00
|
|
|
struct nfc_se *nfc_find_se(struct nfc_dev *dev, u32 se_idx);
|
2013-05-10 21:28:38 +08:00
|
|
|
|
2014-05-05 18:43:31 +08:00
|
|
|
void nfc_send_to_raw_sock(struct nfc_dev *dev, struct sk_buff *skb,
|
|
|
|
u8 payload_type, u8 direction);
|
|
|
|
|
2011-07-02 06:31:33 +08:00
|
|
|
#endif /* __NET_NFC_H */
|