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, write to the
  20  * Free Software Foundation, Inc.,
  21  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  22  */
  23
  24 #ifndef __NET_NFC_H
  25 #define __NET_NFC_H
  26
  27 #include <linux/nfc.h>
  28 #include <linux/device.h>
  29 #include <linux/skbuff.h>
  30
  31 #define nfc_dev_info(dev, fmt, arg...) dev_info((dev), "NFC: " fmt "\n", ## arg)
  32 #define nfc_dev_err(dev, fmt, arg...) dev_err((dev), "NFC: " fmt "\n", ## arg)
  33 #define nfc_dev_dbg(dev, fmt, arg...) dev_dbg((dev), fmt "\n", ## arg)
  34
  35 struct nfc_dev;
  36
  37 /**
  38  * data_exchange_cb_t - Definition of nfc_data_exchange callback
  39  *
  40  * @context: nfc_data_exchange cb_context parameter
  41  * @skb: response data
  42  * @err: If an error has occurred during data exchange, it is the
  43  *      error number. Zero means no error.
  44  *
  45  * When a rx or tx package is lost or corrupted or the target gets out
  46  * of the operating field, err is -EIO.
  47  */
  48 typedef void (*data_exchange_cb_t)(void *context, struct sk_buff *skb,
  49                                                                 int err);
  50
  51 struct nfc_target;
  52
  53 struct nfc_ops {
  54         int (*dev_up)(struct nfc_dev *dev);
  55         int (*dev_down)(struct nfc_dev *dev);
  56         int (*start_poll)(struct nfc_dev *dev,
  57                           u32 im_protocols, u32 tm_protocols);
  58         void (*stop_poll)(struct nfc_dev *dev);
  59         int (*dep_link_up)(struct nfc_dev *dev, struct nfc_target *target,
  60                            u8 comm_mode, u8 *gb, size_t gb_len);
  61         int (*dep_link_down)(struct nfc_dev *dev);
  62         int (*activate_target)(struct nfc_dev *dev, struct nfc_target *target,
  63                                u32 protocol);
  64         void (*deactivate_target)(struct nfc_dev *dev,
  65                                   struct nfc_target *target);
  66         int (*im_transceive)(struct nfc_dev *dev, struct nfc_target *target,
  67                              struct sk_buff *skb, data_exchange_cb_t cb,
  68                              void *cb_context);
  69         int (*tm_send)(struct nfc_dev *dev, struct sk_buff *skb);
  70         int (*check_presence)(struct nfc_dev *dev, struct nfc_target *target);
  71         int (*fw_download)(struct nfc_dev *dev, const char *firmware_name);
  72
  73         /* Secure Element API */
  74         int (*discover_se)(struct nfc_dev *dev);
  75         int (*enable_se)(struct nfc_dev *dev, u32 se_idx);
  76         int (*disable_se)(struct nfc_dev *dev, u32 se_idx);
  77 };
  78
  79 #define NFC_TARGET_IDX_ANY -1
  80 #define NFC_MAX_GT_LEN 48
  81 #define NFC_ATR_RES_GT_OFFSET 15
  82
  83 struct nfc_target {
  84         u32 idx;
  85         u32 supported_protocols;
  86         u16 sens_res;
  87         u8 sel_res;
  88         u8 nfcid1_len;
  89         u8 nfcid1[NFC_NFCID1_MAXSIZE];
  90         u8 nfcid2_len;
  91         u8 nfcid2[NFC_NFCID2_MAXSIZE];
  92         u8 sensb_res_len;
  93         u8 sensb_res[NFC_SENSB_RES_MAXSIZE];
  94         u8 sensf_res_len;
  95         u8 sensf_res[NFC_SENSF_RES_MAXSIZE];
  96         u8 hci_reader_gate;
  97         u8 logical_idx;
  98 };
  99
 100 /**
 101  * nfc_se - A structure for NFC accessible secure elements.
 102  *
 103  * @idx: The secure element index. User space will enable or
 104  *       disable a secure element by its index.
 105  * @type: The secure element type. It can be SE_UICC or
 106  *        SE_EMBEDDED.
 107  * @state: The secure element state, either enabled or disabled.
 108  *
 109  */
 110 struct nfc_se {
 111         struct list_head list;
 112         u32 idx;
 113         u16 type;
 114         u16 state;
 115 };
 116
 117 struct nfc_genl_data {
 118         u32 poll_req_portid;
 119         struct mutex genl_data_mutex;
 120 };
 121
 122 struct nfc_dev {
 123         int idx;
 124         u32 target_next_idx;
 125         struct nfc_target *targets;
 126         int n_targets;
 127         int targets_generation;
 128         struct device dev;
 129         bool dev_up;
 130         bool fw_download_in_progress;
 131         u8 rf_mode;
 132         bool polling;
 133         struct nfc_target *active_target;
 134         bool dep_link_up;
 135         struct nfc_genl_data genl_data;
 136         u32 supported_protocols;
 137
 138         struct list_head secure_elements;
 139
 140         int tx_headroom;
 141         int tx_tailroom;
 142
 143         struct timer_list check_pres_timer;
 144         struct work_struct check_pres_work;
 145
 146         bool shutting_down;
 147
 148         struct rfkill *rfkill;
 149
 150         struct nfc_ops *ops;
 151 };
 152 #define to_nfc_dev(_dev) container_of(_dev, struct nfc_dev, dev)
 153
 154 extern struct class nfc_class;
 155
 156 struct nfc_dev *nfc_allocate_device(struct nfc_ops *ops,
 157                                     u32 supported_protocols,
 158                                     int tx_headroom,
 159                                     int tx_tailroom);
 160
 161 /**
 162  * nfc_free_device - free nfc device
 163  *
 164  * @dev: The nfc device to free
 165  */
 166 static inline void nfc_free_device(struct nfc_dev *dev)
 167 {
 168         put_device(&dev->dev);
 169 }
 170
 171 int nfc_register_device(struct nfc_dev *dev);
 172
 173 void nfc_unregister_device(struct nfc_dev *dev);
 174
 175 /**
 176  * nfc_set_parent_dev - set the parent device
 177  *
 178  * @nfc_dev: The nfc device whose parent is being set
 179  * @dev: The parent device
 180  */
 181 static inline void nfc_set_parent_dev(struct nfc_dev *nfc_dev,
 182                                       struct device *dev)
 183 {
 184         nfc_dev->dev.parent = dev;
 185 }
 186
 187 /**
 188  * nfc_set_drvdata - set driver specifc data
 189  *
 190  * @dev: The nfc device
 191  * @data: Pointer to driver specifc data
 192  */
 193 static inline void nfc_set_drvdata(struct nfc_dev *dev, void *data)
 194 {
 195         dev_set_drvdata(&dev->dev, data);
 196 }
 197
 198 /**
 199  * nfc_get_drvdata - get driver specifc data
 200  *
 201  * @dev: The nfc device
 202  */
 203 static inline void *nfc_get_drvdata(struct nfc_dev *dev)
 204 {
 205         return dev_get_drvdata(&dev->dev);
 206 }
 207
 208 /**
 209  * nfc_device_name - get the nfc device name
 210  *
 211  * @dev: The nfc device whose name to return
 212  */
 213 static inline const char *nfc_device_name(struct nfc_dev *dev)
 214 {
 215         return dev_name(&dev->dev);
 216 }
 217
 218 struct sk_buff *nfc_alloc_send_skb(struct nfc_dev *dev, struct sock *sk,
 219                                    unsigned int flags, unsigned int size,
 220                                    unsigned int *err);
 221 struct sk_buff *nfc_alloc_recv_skb(unsigned int size, gfp_t gfp);
 222
 223 int nfc_set_remote_general_bytes(struct nfc_dev *dev,
 224                                  u8 *gt, u8 gt_len);
 225 u8 *nfc_get_local_general_bytes(struct nfc_dev *dev, size_t *gb_len);
 226
 227 int nfc_fw_download_done(struct nfc_dev *dev, const char *firmware_name,
 228                          u32 result);
 229
 230 int nfc_targets_found(struct nfc_dev *dev,
 231                       struct nfc_target *targets, int ntargets);
 232 int nfc_target_lost(struct nfc_dev *dev, u32 target_idx);
 233
 234 int nfc_dep_link_is_up(struct nfc_dev *dev, u32 target_idx,
 235                        u8 comm_mode, u8 rf_mode);
 236
 237 int nfc_tm_activated(struct nfc_dev *dev, u32 protocol, u8 comm_mode,
 238                      u8 *gb, size_t gb_len);
 239 int nfc_tm_deactivated(struct nfc_dev *dev);
 240 int nfc_tm_data_received(struct nfc_dev *dev, struct sk_buff *skb);
 241
 242 void nfc_driver_failure(struct nfc_dev *dev, int err);
 243
 244 int nfc_add_se(struct nfc_dev *dev, u32 se_idx, u16 type);
 245 int nfc_remove_se(struct nfc_dev *dev, u32 se_idx);
 246
 247 #endif /* __NET_NFC_H */