include/net/nfc/nfc.h

   1 /*
   2  * Copyright (C) 2011 Instituto Nokia de Tecnologia
   3  * Copyright (C) 2014 Marvell International Ltd.
   4  *
   5  * Authors:
   6  *    Lauro Ramos Venancio <lauro.venancio@openbossa.org>
   7  *    Aloisio Almeida Jr <aloisio.almeida@openbossa.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  21  */
  22
  23 #ifndef __NET_NFC_H
  24 #define __NET_NFC_H
  25
  26 #include <linux/nfc.h>
  27 #include <linux/device.h>
  28 #include <linux/skbuff.h>
  29
  30 #define nfc_info(dev, fmt, ...) dev_info((dev), "NFC: " fmt, ##__VA_ARGS__)
  31 #define nfc_err(dev, fmt, ...) dev_err((dev), "NFC: " fmt, ##__VA_ARGS__)
  32
  33 struct nfc_phy_ops {
  34         int (*write)(void *dev_id, struct sk_buff *skb);
  35         int (*enable)(void *dev_id);
  36         void (*disable)(void *dev_id);
  37 };
  38
  39 struct nfc_dev;
  40
  41 /**
  42  * data_exchange_cb_t - Definition of nfc_data_exchange callback
  43  *
  44  * @context: nfc_data_exchange cb_context parameter
  45  * @skb: response data
  46  * @err: If an error has occurred during data exchange, it is the
  47  *      error number. Zero means no error.
  48  *
  49  * When a rx or tx package is lost or corrupted or the target gets out
  50  * of the operating field, err is -EIO.
  51  */
  52 typedef void (*data_exchange_cb_t)(void *context, struct sk_buff *skb,
  53                                                                 int err);
  54
  55 typedef void (*se_io_cb_t)(void *context, u8 *apdu, size_t apdu_len, int err);
  56
  57 struct nfc_target;
  58
  59 struct nfc_ops {
  60         int (*dev_up)(struct nfc_dev *dev);
  61         int (*dev_down)(struct nfc_dev *dev);
  62         int (*start_poll)(struct nfc_dev *dev,
  63                           u32 im_protocols, u32 tm_protocols);
  64         void (*stop_poll)(struct nfc_dev *dev);
  65         int (*dep_link_up)(struct nfc_dev *dev, struct nfc_target *target,
  66                            u8 comm_mode, u8 *gb, size_t gb_len);
  67         int (*dep_link_down)(struct nfc_dev *dev);
  68         int (*activate_target)(struct nfc_dev *dev, struct nfc_target *target,
  69                                u32 protocol);
  70         void (*deactivate_target)(struct nfc_dev *dev,
  71                                   struct nfc_target *target, u8 mode);
  72         int (*im_transceive)(struct nfc_dev *dev, struct nfc_target *target,
  73                              struct sk_buff *skb, data_exchange_cb_t cb,
  74                              void *cb_context);
  75         int (*tm_send)(struct nfc_dev *dev, struct sk_buff *skb);
  76         int (*check_presence)(struct nfc_dev *dev, struct nfc_target *target);
  77         int (*fw_download)(struct nfc_dev *dev, const char *firmware_name);
  78
  79         /* Secure Element API */
  80         int (*discover_se)(struct nfc_dev *dev);
  81         int (*enable_se)(struct nfc_dev *dev, u32 se_idx);
  82         int (*disable_se)(struct nfc_dev *dev, u32 se_idx);
  83         int (*se_io) (struct nfc_dev *dev, u32 se_idx,
  84                       u8 *apdu, size_t apdu_length,
  85                       se_io_cb_t cb, void *cb_context);
  86 };
  87
  88 #define NFC_TARGET_IDX_ANY -1
  89 #define NFC_MAX_GT_LEN 48
  90 #define NFC_ATR_RES_GT_OFFSET 15
  91 #define NFC_ATR_REQ_GT_OFFSET 14
  92
  93 /**
  94  * struct nfc_target - NFC target descriptiom
  95  *
  96  * @sens_res: 2 bytes describing the target SENS_RES response, if the target
  97  *      is a type A one. The %sens_res most significant byte must be byte 2
  98  *      as described by the NFC Forum digital specification (i.e. the platform
  99  *      configuration one) while %sens_res least significant byte is byte 1.
 100  */
 101 struct nfc_target {
 102         u32 idx;
 103         u32 supported_protocols;
 104         u16 sens_res;
 105         u8 sel_res;
 106         u8 nfcid1_len;
 107         u8 nfcid1[NFC_NFCID1_MAXSIZE];
 108         u8 nfcid2_len;
 109         u8 nfcid2[NFC_NFCID2_MAXSIZE];
 110         u8 sensb_res_len;
 111         u8 sensb_res[NFC_SENSB_RES_MAXSIZE];
 112         u8 sensf_res_len;
 113         u8 sensf_res[NFC_SENSF_RES_MAXSIZE];
 114         u8 hci_reader_gate;
 115         u8 logical_idx;
 116         u8 is_iso15693;
 117         u8 iso15693_dsfid;
 118         u8 iso15693_uid[NFC_ISO15693_UID_MAXSIZE];
 119 };
 120
 121 /**
 122  * nfc_se - A structure for NFC accessible secure elements.
 123  *
 124  * @idx: The secure element index. User space will enable or
 125  *       disable a secure element by its index.
 126  * @type: The secure element type. It can be SE_UICC or
 127  *        SE_EMBEDDED.
 128  * @state: The secure element state, either enabled or disabled.
 129  *
 130  */
 131 struct nfc_se {
 132         struct list_head list;
 133         u32 idx;
 134         u16 type;
 135         u16 state;
 136 };
 137
 138 /**
 139  * nfc_evt_transaction - A struct for NFC secure element event transaction.
 140  *
 141  * @aid: The application identifier triggering the event
 142  *
 143  * @aid_len: The application identifier length [5:16]
 144  *
 145  * @params: The application parameters transmitted during the transaction
 146  *
 147  * @params_len: The applications parameters length [0:255]
 148  *
 149  */
 150 #define NFC_MIN_AID_LENGTH      5
 151 #define NFC_MAX_AID_LENGTH      16
 152 #define NFC_MAX_PARAMS_LENGTH   255
 153
 154 #define NFC_EVT_TRANSACTION_AID_TAG     0x81
 155 #define NFC_EVT_TRANSACTION_PARAMS_TAG  0x82
 156 struct nfc_evt_transaction {
 157         u32 aid_len;
 158         u8 aid[NFC_MAX_AID_LENGTH];
 159         u8 params_len;
 160         u8 params[0];
 161 } __packed;
 162
 163 struct nfc_genl_data {
 164         u32 poll_req_portid;
 165         struct mutex genl_data_mutex;
 166 };
 167
 168 struct nfc_vendor_cmd {
 169         __u32 vendor_id;
 170         __u32 subcmd;
 171         int (*doit)(struct nfc_dev *dev, void *data, size_t data_len);
 172 };
 173
 174 struct nfc_dev {
 175         int idx;
 176         u32 target_next_idx;
 177         struct nfc_target *targets;
 178         int n_targets;
 179         int targets_generation;
 180         struct device dev;
 181         bool dev_up;
 182         bool fw_download_in_progress;
 183         u8 rf_mode;
 184         bool polling;
 185         struct nfc_target *active_target;
 186         bool dep_link_up;
 187         struct nfc_genl_data genl_data;
 188         u32 supported_protocols;
 189
 190         struct list_head secure_elements;
 191
 192         int tx_headroom;
 193         int tx_tailroom;
 194
 195         struct timer_list check_pres_timer;
 196         struct work_struct check_pres_work;
 197
 198         bool shutting_down;
 199
 200         struct rfkill *rfkill;
 201
 202         struct nfc_vendor_cmd *vendor_cmds;
 203         int n_vendor_cmds;
 204
 205         struct nfc_ops *ops;
 206         struct genl_info *cur_cmd_info;
 207 };
 208 #define to_nfc_dev(_dev) container_of(_dev, struct nfc_dev, dev)
 209
 210 extern struct class nfc_class;
 211
 212 struct nfc_dev *nfc_allocate_device(struct nfc_ops *ops,
 213                                     u32 supported_protocols,
 214                                     int tx_headroom,
 215                                     int tx_tailroom);
 216
 217 /**
 218  * nfc_free_device - free nfc device
 219  *
 220  * @dev: The nfc device to free
 221  */
 222 static inline void nfc_free_device(struct nfc_dev *dev)
 223 {
 224         put_device(&dev->dev);
 225 }
 226
 227 int nfc_register_device(struct nfc_dev *dev);
 228
 229 void nfc_unregister_device(struct nfc_dev *dev);
 230
 231 /**
 232  * nfc_set_parent_dev - set the parent device
 233  *
 234  * @nfc_dev: The nfc device whose parent is being set
 235  * @dev: The parent device
 236  */
 237 static inline void nfc_set_parent_dev(struct nfc_dev *nfc_dev,
 238                                       struct device *dev)
 239 {
 240         nfc_dev->dev.parent = dev;
 241 }
 242
 243 /**
 244  * nfc_set_drvdata - set driver specifc data
 245  *
 246  * @dev: The nfc device
 247  * @data: Pointer to driver specifc data
 248  */
 249 static inline void nfc_set_drvdata(struct nfc_dev *dev, void *data)
 250 {
 251         dev_set_drvdata(&dev->dev, data);
 252 }
 253
 254 /**
 255  * nfc_get_drvdata - get driver specifc data
 256  *
 257  * @dev: The nfc device
 258  */
 259 static inline void *nfc_get_drvdata(struct nfc_dev *dev)
 260 {
 261         return dev_get_drvdata(&dev->dev);
 262 }
 263
 264 /**
 265  * nfc_device_name - get the nfc device name
 266  *
 267  * @dev: The nfc device whose name to return
 268  */
 269 static inline const char *nfc_device_name(struct nfc_dev *dev)
 270 {
 271         return dev_name(&dev->dev);
 272 }
 273
 274 struct sk_buff *nfc_alloc_send_skb(struct nfc_dev *dev, struct sock *sk,
 275                                    unsigned int flags, unsigned int size,
 276                                    unsigned int *err);
 277 struct sk_buff *nfc_alloc_recv_skb(unsigned int size, gfp_t gfp);
 278
 279 int nfc_set_remote_general_bytes(struct nfc_dev *dev,
 280                                  u8 *gt, u8 gt_len);
 281 u8 *nfc_get_local_general_bytes(struct nfc_dev *dev, size_t *gb_len);
 282
 283 int nfc_fw_download_done(struct nfc_dev *dev, const char *firmware_name,
 284                          u32 result);
 285
 286 int nfc_targets_found(struct nfc_dev *dev,
 287                       struct nfc_target *targets, int ntargets);
 288 int nfc_target_lost(struct nfc_dev *dev, u32 target_idx);
 289
 290 int nfc_dep_link_is_up(struct nfc_dev *dev, u32 target_idx,
 291                        u8 comm_mode, u8 rf_mode);
 292
 293 int nfc_tm_activated(struct nfc_dev *dev, u32 protocol, u8 comm_mode,
 294                      u8 *gb, size_t gb_len);
 295 int nfc_tm_deactivated(struct nfc_dev *dev);
 296 int nfc_tm_data_received(struct nfc_dev *dev, struct sk_buff *skb);
 297
 298 void nfc_driver_failure(struct nfc_dev *dev, int err);
 299
 300 int nfc_se_transaction(struct nfc_dev *dev, u8 se_idx,
 301                        struct nfc_evt_transaction *evt_transaction);
 302 int nfc_add_se(struct nfc_dev *dev, u32 se_idx, u16 type);
 303 int nfc_remove_se(struct nfc_dev *dev, u32 se_idx);
 304 struct nfc_se *nfc_find_se(struct nfc_dev *dev, u32 se_idx);
 305
 306 void nfc_send_to_raw_sock(struct nfc_dev *dev, struct sk_buff *skb,
 307                           u8 payload_type, u8 direction);
 308
 309 static inline int nfc_set_vendor_cmds(struct nfc_dev *dev,
 310                                       struct nfc_vendor_cmd *cmds,
 311                                       int n_cmds)
 312 {
 313         if (dev->vendor_cmds || dev->n_vendor_cmds)
 314                 return -EINVAL;
 315
 316         dev->vendor_cmds = cmds;
 317         dev->n_vendor_cmds = n_cmds;
 318
 319         return 0;
 320 }
 321
 322 struct sk_buff *__nfc_alloc_vendor_cmd_reply_skb(struct nfc_dev *dev,
 323                                                  enum nfc_attrs attr,
 324                                                  u32 oui, u32 subcmd,
 325                                                  int approxlen);
 326 int nfc_vendor_cmd_reply(struct sk_buff *skb);
 327
 328 /**
 329  * nfc_vendor_cmd_alloc_reply_skb - allocate vendor command reply
 330  * @dev: nfc device
 331  * @oui: vendor oui
 332  * @approxlen: an upper bound of the length of the data that will
 333  *      be put into the skb
 334  *
 335  * This function allocates and pre-fills an skb for a reply to
 336  * a vendor command. Since it is intended for a reply, calling
 337  * it outside of a vendor command's doit() operation is invalid.
 338  *
 339  * The returned skb is pre-filled with some identifying data in
 340  * a way that any data that is put into the skb (with skb_put(),
 341  * nla_put() or similar) will end up being within the
 342  * %NFC_ATTR_VENDOR_DATA attribute, so all that needs to be done
 343  * with the skb is adding data for the corresponding userspace tool
 344  * which can then read that data out of the vendor data attribute.
 345  * You must not modify the skb in any other way.
 346  *
 347  * When done, call nfc_vendor_cmd_reply() with the skb and return
 348  * its error code as the result of the doit() operation.
 349  *
 350  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
 351  */
 352 static inline struct sk_buff *
 353 nfc_vendor_cmd_alloc_reply_skb(struct nfc_dev *dev,
 354                                 u32 oui, u32 subcmd, int approxlen)
 355 {
 356         return __nfc_alloc_vendor_cmd_reply_skb(dev,
 357                                                 NFC_ATTR_VENDOR_DATA,
 358                                                 oui,
 359                                                 subcmd, approxlen);
 360 }
 361
 362 #endif /* __NET_NFC_H */