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_upload)(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 struct nfc_genl_data {
 101         u32 poll_req_portid;
 102         struct mutex genl_data_mutex;
 103 };
 104
 105 struct nfc_dev {
 106         int idx;
 107         u32 target_next_idx;
 108         struct nfc_target *targets;
 109         int n_targets;
 110         int targets_generation;
 111         struct device dev;
 112         bool dev_up;
 113         bool fw_upload_in_progress;
 114         u8 rf_mode;
 115         bool polling;
 116         struct nfc_target *active_target;
 117         bool dep_link_up;
 118         struct nfc_genl_data genl_data;
 119         u32 supported_protocols;
 120
 121         u32 active_se;
 122
 123         int tx_headroom;
 124         int tx_tailroom;
 125
 126         struct timer_list check_pres_timer;
 127         struct work_struct check_pres_work;
 128
 129         bool shutting_down;
 130
 131         struct rfkill *rfkill;
 132
 133         struct nfc_ops *ops;
 134 };
 135 #define to_nfc_dev(_dev) container_of(_dev, struct nfc_dev, dev)
 136
 137 extern struct class nfc_class;
 138
 139 struct nfc_dev *nfc_allocate_device(struct nfc_ops *ops,
 140                                     u32 supported_protocols,
 141                                     int tx_headroom,
 142                                     int tx_tailroom);
 143
 144 /**
 145  * nfc_free_device - free nfc device
 146  *
 147  * @dev: The nfc device to free
 148  */
 149 static inline void nfc_free_device(struct nfc_dev *dev)
 150 {
 151         put_device(&dev->dev);
 152 }
 153
 154 int nfc_register_device(struct nfc_dev *dev);
 155
 156 void nfc_unregister_device(struct nfc_dev *dev);
 157
 158 /**
 159  * nfc_set_parent_dev - set the parent device
 160  *
 161  * @nfc_dev: The nfc device whose parent is being set
 162  * @dev: The parent device
 163  */
 164 static inline void nfc_set_parent_dev(struct nfc_dev *nfc_dev,
 165                                       struct device *dev)
 166 {
 167         nfc_dev->dev.parent = dev;
 168 }
 169
 170 /**
 171  * nfc_set_drvdata - set driver specifc data
 172  *
 173  * @dev: The nfc device
 174  * @data: Pointer to driver specifc data
 175  */
 176 static inline void nfc_set_drvdata(struct nfc_dev *dev, void *data)
 177 {
 178         dev_set_drvdata(&dev->dev, data);
 179 }
 180
 181 /**
 182  * nfc_get_drvdata - get driver specifc data
 183  *
 184  * @dev: The nfc device
 185  */
 186 static inline void *nfc_get_drvdata(struct nfc_dev *dev)
 187 {
 188         return dev_get_drvdata(&dev->dev);
 189 }
 190
 191 /**
 192  * nfc_device_name - get the nfc device name
 193  *
 194  * @dev: The nfc device whose name to return
 195  */
 196 static inline const char *nfc_device_name(struct nfc_dev *dev)
 197 {
 198         return dev_name(&dev->dev);
 199 }
 200
 201 struct sk_buff *nfc_alloc_send_skb(struct nfc_dev *dev, struct sock *sk,
 202                                    unsigned int flags, unsigned int size,
 203                                    unsigned int *err);
 204 struct sk_buff *nfc_alloc_recv_skb(unsigned int size, gfp_t gfp);
 205
 206 int nfc_set_remote_general_bytes(struct nfc_dev *dev,
 207                                  u8 *gt, u8 gt_len);
 208 u8 *nfc_get_local_general_bytes(struct nfc_dev *dev, size_t *gb_len);
 209
 210 int nfc_targets_found(struct nfc_dev *dev,
 211                       struct nfc_target *targets, int ntargets);
 212 int nfc_target_lost(struct nfc_dev *dev, u32 target_idx);
 213
 214 int nfc_dep_link_is_up(struct nfc_dev *dev, u32 target_idx,
 215                        u8 comm_mode, u8 rf_mode);
 216
 217 int nfc_tm_activated(struct nfc_dev *dev, u32 protocol, u8 comm_mode,
 218                      u8 *gb, size_t gb_len);
 219 int nfc_tm_deactivated(struct nfc_dev *dev);
 220 int nfc_tm_data_received(struct nfc_dev *dev, struct sk_buff *skb);
 221
 222 void nfc_driver_failure(struct nfc_dev *dev, int err);
 223
 224 #endif /* __NET_NFC_H */