include/net/nfc/nfc.h

   1 /*
   2  * Copyright (C) 2011 Instituto Nokia de Tecnologia
   3  *
   4  * Authors:
   5  *    Lauro Ramos Venancio <lauro.venancio@openbossa.org>
   6  *    Aloisio Almeida Jr <aloisio.almeida@openbossa.org>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22 #ifndef __NET_NFC_H
  23 #define __NET_NFC_H
  24
  25 #include <linux/nfc.h>
  26 #include <linux/device.h>
  27 #include <linux/skbuff.h>
  28
  29 #define nfc_info(dev, fmt, ...) dev_info((dev), "NFC: " fmt, ##__VA_ARGS__)
  30 #define nfc_err(dev, fmt, ...) dev_err((dev), "NFC: " fmt, ##__VA_ARGS__)
  31
  32 struct nfc_phy_ops {
  33         int (*write)(void *dev_id, struct sk_buff *skb);
  34         int (*enable)(void *dev_id);
  35         void (*disable)(void *dev_id);
  36 };
  37
  38 struct nfc_dev;
  39
  40 /**
  41  * data_exchange_cb_t - Definition of nfc_data_exchange callback
  42  *
  43  * @context: nfc_data_exchange cb_context parameter
  44  * @skb: response data
  45  * @err: If an error has occurred during data exchange, it is the
  46  *      error number. Zero means no error.
  47  *
  48  * When a rx or tx package is lost or corrupted or the target gets out
  49  * of the operating field, err is -EIO.
  50  */
  51 typedef void (*data_exchange_cb_t)(void *context, struct sk_buff *skb,
  52                                                                 int err);
  53
  54 typedef void (*se_io_cb_t)(void *context, u8 *apdu, size_t apdu_len, int err);
  55
  56 struct nfc_target;
  57
  58 struct nfc_ops {
  59         int (*dev_up)(struct nfc_dev *dev);
  60         int (*dev_down)(struct nfc_dev *dev);
  61         int (*start_poll)(struct nfc_dev *dev,
  62                           u32 im_protocols, u32 tm_protocols);
  63         void (*stop_poll)(struct nfc_dev *dev);
  64         int (*dep_link_up)(struct nfc_dev *dev, struct nfc_target *target,
  65                            u8 comm_mode, u8 *gb, size_t gb_len);
  66         int (*dep_link_down)(struct nfc_dev *dev);
  67         int (*activate_target)(struct nfc_dev *dev, struct nfc_target *target,
  68                                u32 protocol);
  69         void (*deactivate_target)(struct nfc_dev *dev,
  70                                   struct nfc_target *target);
  71         int (*im_transceive)(struct nfc_dev *dev, struct nfc_target *target,
  72                              struct sk_buff *skb, data_exchange_cb_t cb,
  73                              void *cb_context);
  74         int (*tm_send)(struct nfc_dev *dev, struct sk_buff *skb);
  75         int (*check_presence)(struct nfc_dev *dev, struct nfc_target *target);
  76         int (*fw_download)(struct nfc_dev *dev, const char *firmware_name);
  77
  78         /* Secure Element API */
  79         int (*discover_se)(struct nfc_dev *dev);
  80         int (*enable_se)(struct nfc_dev *dev, u32 se_idx);
  81         int (*disable_se)(struct nfc_dev *dev, u32 se_idx);
  82         int (*se_io) (struct nfc_dev *dev, u32 se_idx,
  83                       u8 *apdu, size_t apdu_length,
  84                       se_io_cb_t cb, void *cb_context);
  85 };
  86
  87 #define NFC_TARGET_IDX_ANY -1
  88 #define NFC_MAX_GT_LEN 48
  89 #define NFC_ATR_RES_GT_OFFSET 15
  90
  91 /**
  92  * struct nfc_target - NFC target descriptiom
  93  *
  94  * @sens_res: 2 bytes describing the target SENS_RES response, if the target
  95  *      is a type A one. The %sens_res most significant byte must be byte 2
  96  *      as described by the NFC Forum digital specification (i.e. the platform
  97  *      configuration one) while %sens_res least significant byte is byte 1.
  98  */
  99 struct nfc_target {
 100         u32 idx;
 101         u32 supported_protocols;
 102         u16 sens_res;
 103         u8 sel_res;
 104         u8 nfcid1_len;
 105         u8 nfcid1[NFC_NFCID1_MAXSIZE];
 106         u8 nfcid2_len;
 107         u8 nfcid2[NFC_NFCID2_MAXSIZE];
 108         u8 sensb_res_len;
 109         u8 sensb_res[NFC_SENSB_RES_MAXSIZE];
 110         u8 sensf_res_len;
 111         u8 sensf_res[NFC_SENSF_RES_MAXSIZE];
 112         u8 hci_reader_gate;
 113         u8 logical_idx;
 114         u8 is_iso15693;
 115         u8 iso15693_dsfid;
 116         u8 iso15693_uid[NFC_ISO15693_UID_MAXSIZE];
 117 };
 118
 119 /**
 120  * nfc_se - A structure for NFC accessible secure elements.
 121  *
 122  * @idx: The secure element index. User space will enable or
 123  *       disable a secure element by its index.
 124  * @type: The secure element type. It can be SE_UICC or
 125  *        SE_EMBEDDED.
 126  * @state: The secure element state, either enabled or disabled.
 127  *
 128  */
 129 struct nfc_se {
 130         struct list_head list;
 131         u32 idx;
 132         u16 type;
 133         u16 state;
 134 };
 135
 136 struct nfc_genl_data {
 137         u32 poll_req_portid;
 138         struct mutex genl_data_mutex;
 139 };
 140
 141 struct nfc_dev {
 142         int idx;
 143         u32 target_next_idx;
 144         struct nfc_target *targets;
 145         int n_targets;
 146         int targets_generation;
 147         struct device dev;
 148         bool dev_up;
 149         bool fw_download_in_progress;
 150         u8 rf_mode;
 151         bool polling;
 152         struct nfc_target *active_target;
 153         bool dep_link_up;
 154         struct nfc_genl_data genl_data;
 155         u32 supported_protocols;
 156
 157         struct list_head secure_elements;
 158
 159         int tx_headroom;
 160         int tx_tailroom;
 161
 162         struct timer_list check_pres_timer;
 163         struct work_struct check_pres_work;
 164
 165         bool shutting_down;
 166
 167         struct rfkill *rfkill;
 168
 169         struct nfc_ops *ops;
 170 };
 171 #define to_nfc_dev(_dev) container_of(_dev, struct nfc_dev, dev)
 172
 173 extern struct class nfc_class;
 174
 175 struct nfc_dev *nfc_allocate_device(struct nfc_ops *ops,
 176                                     u32 supported_protocols,
 177                                     int tx_headroom,
 178                                     int tx_tailroom);
 179
 180 /**
 181  * nfc_free_device - free nfc device
 182  *
 183  * @dev: The nfc device to free
 184  */
 185 static inline void nfc_free_device(struct nfc_dev *dev)
 186 {
 187         put_device(&dev->dev);
 188 }
 189
 190 int nfc_register_device(struct nfc_dev *dev);
 191
 192 void nfc_unregister_device(struct nfc_dev *dev);
 193
 194 /**
 195  * nfc_set_parent_dev - set the parent device
 196  *
 197  * @nfc_dev: The nfc device whose parent is being set
 198  * @dev: The parent device
 199  */
 200 static inline void nfc_set_parent_dev(struct nfc_dev *nfc_dev,
 201                                       struct device *dev)
 202 {
 203         nfc_dev->dev.parent = dev;
 204 }
 205
 206 /**
 207  * nfc_set_drvdata - set driver specifc data
 208  *
 209  * @dev: The nfc device
 210  * @data: Pointer to driver specifc data
 211  */
 212 static inline void nfc_set_drvdata(struct nfc_dev *dev, void *data)
 213 {
 214         dev_set_drvdata(&dev->dev, data);
 215 }
 216
 217 /**
 218  * nfc_get_drvdata - get driver specifc data
 219  *
 220  * @dev: The nfc device
 221  */
 222 static inline void *nfc_get_drvdata(struct nfc_dev *dev)
 223 {
 224         return dev_get_drvdata(&dev->dev);
 225 }
 226
 227 /**
 228  * nfc_device_name - get the nfc device name
 229  *
 230  * @dev: The nfc device whose name to return
 231  */
 232 static inline const char *nfc_device_name(struct nfc_dev *dev)
 233 {
 234         return dev_name(&dev->dev);
 235 }
 236
 237 struct sk_buff *nfc_alloc_send_skb(struct nfc_dev *dev, struct sock *sk,
 238                                    unsigned int flags, unsigned int size,
 239                                    unsigned int *err);
 240 struct sk_buff *nfc_alloc_recv_skb(unsigned int size, gfp_t gfp);
 241
 242 int nfc_set_remote_general_bytes(struct nfc_dev *dev,
 243                                  u8 *gt, u8 gt_len);
 244 u8 *nfc_get_local_general_bytes(struct nfc_dev *dev, size_t *gb_len);
 245
 246 int nfc_fw_download_done(struct nfc_dev *dev, const char *firmware_name,
 247                          u32 result);
 248
 249 int nfc_targets_found(struct nfc_dev *dev,
 250                       struct nfc_target *targets, int ntargets);
 251 int nfc_target_lost(struct nfc_dev *dev, u32 target_idx);
 252
 253 int nfc_dep_link_is_up(struct nfc_dev *dev, u32 target_idx,
 254                        u8 comm_mode, u8 rf_mode);
 255
 256 int nfc_tm_activated(struct nfc_dev *dev, u32 protocol, u8 comm_mode,
 257                      u8 *gb, size_t gb_len);
 258 int nfc_tm_deactivated(struct nfc_dev *dev);
 259 int nfc_tm_data_received(struct nfc_dev *dev, struct sk_buff *skb);
 260
 261 void nfc_driver_failure(struct nfc_dev *dev, int err);
 262
 263 int nfc_add_se(struct nfc_dev *dev, u32 se_idx, u16 type);
 264 int nfc_remove_se(struct nfc_dev *dev, u32 se_idx);
 265 struct nfc_se *nfc_find_se(struct nfc_dev *dev, u32 se_idx);
 266
 267 void nfc_send_to_raw_sock(struct nfc_dev *dev, struct sk_buff *skb,
 268                           u8 payload_type, u8 direction);
 269
 270 #endif /* __NET_NFC_H */