net/nfc/nfc.h

0001 /* SPDX-License-Identifier: GPL-2.0-or-later */
0002 /*
0003  * Copyright (C) 2011 Instituto Nokia de Tecnologia
0004  * Copyright (C) 2014 Marvell International Ltd.
0005  *
0006  * Authors:
0007  *    Lauro Ramos Venancio <lauro.venancio@openbossa.org>
0008  *    Aloisio Almeida Jr <aloisio.almeida@openbossa.org>
0009  */
0010
0011 #ifndef __NET_NFC_H
0012 #define __NET_NFC_H
0013
0014 #include <linux/nfc.h>
0015 #include <linux/device.h>
0016 #include <linux/skbuff.h>
0017
0018 #define nfc_dbg(dev, fmt, ...) dev_dbg((dev), "NFC: " fmt, ##__VA_ARGS__)
0019 #define nfc_info(dev, fmt, ...) dev_info((dev), "NFC: " fmt, ##__VA_ARGS__)
0020 #define nfc_err(dev, fmt, ...) dev_err((dev), "NFC: " fmt, ##__VA_ARGS__)
0021
0022 struct nfc_phy_ops {
0023     int (*write)(void *dev_id, struct sk_buff *skb);
0024     int (*enable)(void *dev_id);
0025     void (*disable)(void *dev_id);
0026 };
0027
0028 struct nfc_dev;
0029
0030 /**
0031  * data_exchange_cb_t - Definition of nfc_data_exchange callback
0032  *
0033  * @context: nfc_data_exchange cb_context parameter
0034  * @skb: response data
0035  * @err: If an error has occurred during data exchange, it is the
0036  *  error number. Zero means no error.
0037  *
0038  * When a rx or tx package is lost or corrupted or the target gets out
0039  * of the operating field, err is -EIO.
0040  */
0041 typedef void (*data_exchange_cb_t)(void *context, struct sk_buff *skb,
0042                                 int err);
0043
0044 typedef void (*se_io_cb_t)(void *context, u8 *apdu, size_t apdu_len, int err);
0045
0046 struct nfc_target;
0047
0048 struct nfc_ops {
0049     int (*dev_up)(struct nfc_dev *dev);
0050     int (*dev_down)(struct nfc_dev *dev);
0051     int (*start_poll)(struct nfc_dev *dev,
0052               u32 im_protocols, u32 tm_protocols);
0053     void (*stop_poll)(struct nfc_dev *dev);
0054     int (*dep_link_up)(struct nfc_dev *dev, struct nfc_target *target,
0055                u8 comm_mode, u8 *gb, size_t gb_len);
0056     int (*dep_link_down)(struct nfc_dev *dev);
0057     int (*activate_target)(struct nfc_dev *dev, struct nfc_target *target,
0058                    u32 protocol);
0059     void (*deactivate_target)(struct nfc_dev *dev,
0060                   struct nfc_target *target, u8 mode);
0061     int (*im_transceive)(struct nfc_dev *dev, struct nfc_target *target,
0062                  struct sk_buff *skb, data_exchange_cb_t cb,
0063                  void *cb_context);
0064     int (*tm_send)(struct nfc_dev *dev, struct sk_buff *skb);
0065     int (*check_presence)(struct nfc_dev *dev, struct nfc_target *target);
0066     int (*fw_download)(struct nfc_dev *dev, const char *firmware_name);
0067
0068     /* Secure Element API */
0069     int (*discover_se)(struct nfc_dev *dev);
0070     int (*enable_se)(struct nfc_dev *dev, u32 se_idx);
0071     int (*disable_se)(struct nfc_dev *dev, u32 se_idx);
0072     int (*se_io) (struct nfc_dev *dev, u32 se_idx,
0073               u8 *apdu, size_t apdu_length,
0074               se_io_cb_t cb, void *cb_context);
0075 };
0076
0077 #define NFC_TARGET_IDX_ANY -1
0078 #define NFC_MAX_GT_LEN 48
0079 #define NFC_ATR_RES_GT_OFFSET 15
0080 #define NFC_ATR_REQ_GT_OFFSET 14
0081
0082 /**
0083  * struct nfc_target - NFC target descriptiom
0084  *
0085  * @sens_res: 2 bytes describing the target SENS_RES response, if the target
0086  *  is a type A one. The %sens_res most significant byte must be byte 2
0087  *  as described by the NFC Forum digital specification (i.e. the platform
0088  *  configuration one) while %sens_res least significant byte is byte 1.
0089  */
0090 struct nfc_target {
0091     u32 idx;
0092     u32 supported_protocols;
0093     u16 sens_res;
0094     u8 sel_res;
0095     u8 nfcid1_len;
0096     u8 nfcid1[NFC_NFCID1_MAXSIZE];
0097     u8 nfcid2_len;
0098     u8 nfcid2[NFC_NFCID2_MAXSIZE];
0099     u8 sensb_res_len;
0100     u8 sensb_res[NFC_SENSB_RES_MAXSIZE];
0101     u8 sensf_res_len;
0102     u8 sensf_res[NFC_SENSF_RES_MAXSIZE];
0103     u8 hci_reader_gate;
0104     u8 logical_idx;
0105     u8 is_iso15693;
0106     u8 iso15693_dsfid;
0107     u8 iso15693_uid[NFC_ISO15693_UID_MAXSIZE];
0108 };
0109
0110 /**
0111  * nfc_se - A structure for NFC accessible secure elements.
0112  *
0113  * @idx: The secure element index. User space will enable or
0114  *       disable a secure element by its index.
0115  * @type: The secure element type. It can be SE_UICC or
0116  *        SE_EMBEDDED.
0117  * @state: The secure element state, either enabled or disabled.
0118  *
0119  */
0120 struct nfc_se {
0121     struct list_head list;
0122     u32 idx;
0123     u16 type;
0124     u16 state;
0125 };
0126
0127 /**
0128  * nfc_evt_transaction - A struct for NFC secure element event transaction.
0129  *
0130  * @aid: The application identifier triggering the event
0131  *
0132  * @aid_len: The application identifier length [5:16]
0133  *
0134  * @params: The application parameters transmitted during the transaction
0135  *
0136  * @params_len: The applications parameters length [0:255]
0137  *
0138  */
0139 #define NFC_MIN_AID_LENGTH  5
0140 #define NFC_MAX_AID_LENGTH  16
0141 #define NFC_MAX_PARAMS_LENGTH   255
0142
0143 #define NFC_EVT_TRANSACTION_AID_TAG 0x81
0144 #define NFC_EVT_TRANSACTION_PARAMS_TAG  0x82
0145 struct nfc_evt_transaction {
0146     u32 aid_len;
0147     u8 aid[NFC_MAX_AID_LENGTH];
0148     u8 params_len;
0149     u8 params[];
0150 } __packed;
0151
0152 struct nfc_genl_data {
0153     u32 poll_req_portid;
0154     struct mutex genl_data_mutex;
0155 };
0156
0157 struct nfc_vendor_cmd {
0158     __u32 vendor_id;
0159     __u32 subcmd;
0160     int (*doit)(struct nfc_dev *dev, void *data, size_t data_len);
0161 };
0162
0163 struct nfc_dev {
0164     int idx;
0165     u32 target_next_idx;
0166     struct nfc_target *targets;
0167     int n_targets;
0168     int targets_generation;
0169     struct device dev;
0170     bool dev_up;
0171     bool fw_download_in_progress;
0172     u8 rf_mode;
0173     bool polling;
0174     struct nfc_target *active_target;
0175     bool dep_link_up;
0176     struct nfc_genl_data genl_data;
0177     u32 supported_protocols;
0178
0179     struct list_head secure_elements;
0180
0181     int tx_headroom;
0182     int tx_tailroom;
0183
0184     struct timer_list check_pres_timer;
0185     struct work_struct check_pres_work;
0186
0187     bool shutting_down;
0188
0189     struct rfkill *rfkill;
0190
0191     const struct nfc_vendor_cmd *vendor_cmds;
0192     int n_vendor_cmds;
0193
0194     const struct nfc_ops *ops;
0195     struct genl_info *cur_cmd_info;
0196 };
0197 #define to_nfc_dev(_dev) container_of(_dev, struct nfc_dev, dev)
0198
0199 extern struct class nfc_class;
0200
0201 struct nfc_dev *nfc_allocate_device(const struct nfc_ops *ops,
0202                     u32 supported_protocols,
0203                     int tx_headroom,
0204                     int tx_tailroom);
0205
0206 /**
0207  * nfc_free_device - free nfc device
0208  *
0209  * @dev: The nfc device to free
0210  */
0211 static inline void nfc_free_device(struct nfc_dev *dev)
0212 {
0213     put_device(&dev->dev);
0214 }
0215
0216 int nfc_register_device(struct nfc_dev *dev);
0217
0218 void nfc_unregister_device(struct nfc_dev *dev);
0219
0220 /**
0221  * nfc_set_parent_dev - set the parent device
0222  *
0223  * @nfc_dev: The nfc device whose parent is being set
0224  * @dev: The parent device
0225  */
0226 static inline void nfc_set_parent_dev(struct nfc_dev *nfc_dev,
0227                       struct device *dev)
0228 {
0229     nfc_dev->dev.parent = dev;
0230 }
0231
0232 /**
0233  * nfc_set_drvdata - set driver specifc data
0234  *
0235  * @dev: The nfc device
0236  * @data: Pointer to driver specifc data
0237  */
0238 static inline void nfc_set_drvdata(struct nfc_dev *dev, void *data)
0239 {
0240     dev_set_drvdata(&dev->dev, data);
0241 }
0242
0243 /**
0244  * nfc_get_drvdata - get driver specifc data
0245  *
0246  * @dev: The nfc device
0247  */
0248 static inline void *nfc_get_drvdata(const struct nfc_dev *dev)
0249 {
0250     return dev_get_drvdata(&dev->dev);
0251 }
0252
0253 /**
0254  * nfc_device_name - get the nfc device name
0255  *
0256  * @dev: The nfc device whose name to return
0257  */
0258 static inline const char *nfc_device_name(const struct nfc_dev *dev)
0259 {
0260     return dev_name(&dev->dev);
0261 }
0262
0263 struct sk_buff *nfc_alloc_send_skb(struct nfc_dev *dev, struct sock *sk,
0264                    unsigned int flags, unsigned int size,
0265                    unsigned int *err);
0266 struct sk_buff *nfc_alloc_recv_skb(unsigned int size, gfp_t gfp);
0267
0268 int nfc_set_remote_general_bytes(struct nfc_dev *dev,
0269                  const u8 *gt, u8 gt_len);
0270 u8 *nfc_get_local_general_bytes(struct nfc_dev *dev, size_t *gb_len);
0271
0272 int nfc_fw_download_done(struct nfc_dev *dev, const char *firmware_name,
0273              u32 result);
0274
0275 int nfc_targets_found(struct nfc_dev *dev,
0276               struct nfc_target *targets, int ntargets);
0277 int nfc_target_lost(struct nfc_dev *dev, u32 target_idx);
0278
0279 int nfc_dep_link_is_up(struct nfc_dev *dev, u32 target_idx,
0280                u8 comm_mode, u8 rf_mode);
0281
0282 int nfc_tm_activated(struct nfc_dev *dev, u32 protocol, u8 comm_mode,
0283              const u8 *gb, size_t gb_len);
0284 int nfc_tm_deactivated(struct nfc_dev *dev);
0285 int nfc_tm_data_received(struct nfc_dev *dev, struct sk_buff *skb);
0286
0287 void nfc_driver_failure(struct nfc_dev *dev, int err);
0288
0289 int nfc_se_transaction(struct nfc_dev *dev, u8 se_idx,
0290                struct nfc_evt_transaction *evt_transaction);
0291 int nfc_se_connectivity(struct nfc_dev *dev, u8 se_idx);
0292 int nfc_add_se(struct nfc_dev *dev, u32 se_idx, u16 type);
0293 int nfc_remove_se(struct nfc_dev *dev, u32 se_idx);
0294 struct nfc_se *nfc_find_se(struct nfc_dev *dev, u32 se_idx);
0295
0296 void nfc_send_to_raw_sock(struct nfc_dev *dev, struct sk_buff *skb,
0297               u8 payload_type, u8 direction);
0298
0299 static inline int nfc_set_vendor_cmds(struct nfc_dev *dev,
0300                       const struct nfc_vendor_cmd *cmds,
0301                       int n_cmds)
0302 {
0303     if (dev->vendor_cmds || dev->n_vendor_cmds)
0304         return -EINVAL;
0305
0306     dev->vendor_cmds = cmds;
0307     dev->n_vendor_cmds = n_cmds;
0308
0309     return 0;
0310 }
0311
0312 struct sk_buff *__nfc_alloc_vendor_cmd_reply_skb(struct nfc_dev *dev,
0313                          enum nfc_attrs attr,
0314                          u32 oui, u32 subcmd,
0315                          int approxlen);
0316 int nfc_vendor_cmd_reply(struct sk_buff *skb);
0317
0318 /**
0319  * nfc_vendor_cmd_alloc_reply_skb - allocate vendor command reply
0320  * @dev: nfc device
0321  * @oui: vendor oui
0322  * @approxlen: an upper bound of the length of the data that will
0323  *      be put into the skb
0324  *
0325  * This function allocates and pre-fills an skb for a reply to
0326  * a vendor command. Since it is intended for a reply, calling
0327  * it outside of a vendor command's doit() operation is invalid.
0328  *
0329  * The returned skb is pre-filled with some identifying data in
0330  * a way that any data that is put into the skb (with skb_put(),
0331  * nla_put() or similar) will end up being within the
0332  * %NFC_ATTR_VENDOR_DATA attribute, so all that needs to be done
0333  * with the skb is adding data for the corresponding userspace tool
0334  * which can then read that data out of the vendor data attribute.
0335  * You must not modify the skb in any other way.
0336  *
0337  * When done, call nfc_vendor_cmd_reply() with the skb and return
0338  * its error code as the result of the doit() operation.
0339  *
0340  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
0341  */
0342 static inline struct sk_buff *
0343 nfc_vendor_cmd_alloc_reply_skb(struct nfc_dev *dev,
0344                 u32 oui, u32 subcmd, int approxlen)
0345 {
0346     return __nfc_alloc_vendor_cmd_reply_skb(dev,
0347                         NFC_ATTR_VENDOR_DATA,
0348                         oui,
0349                         subcmd, approxlen);
0350 }
0351
0352 #endif /* __NET_NFC_H */