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_ops {
  52         int (*dev_up)(struct nfc_dev *dev);
  53         int (*dev_down)(struct nfc_dev *dev);
  54         int (*start_poll)(struct nfc_dev *dev, u32 protocols);
  55         void (*stop_poll)(struct nfc_dev *dev);
  56         int (*dep_link_up)(struct nfc_dev *dev, int target_idx, u8 comm_mode,
  57                            u8 *gb, size_t gb_len);
  58         int (*dep_link_down)(struct nfc_dev *dev);
  59         int (*activate_target)(struct nfc_dev *dev, u32 target_idx,
  60                                u32 protocol);
  61         void (*deactivate_target)(struct nfc_dev *dev, u32 target_idx);
  62         int (*data_exchange)(struct nfc_dev *dev, u32 target_idx,
  63                              struct sk_buff *skb, data_exchange_cb_t cb,
  64                              void *cb_context);
  65         int (*check_presence)(struct nfc_dev *dev, u32 target_idx);
  66 };
  67
  68 #define NFC_TARGET_IDX_ANY -1
  69 #define NFC_MAX_GT_LEN 48
  70 #define NFC_TARGET_IDX_NONE 0xffffffff
  71
  72 struct nfc_target {
  73         u32 idx;
  74         u32 supported_protocols;
  75         u16 sens_res;
  76         u8 sel_res;
  77         u8 nfcid1_len;
  78         u8 nfcid1[NFC_NFCID1_MAXSIZE];
  79         u8 sensb_res_len;
  80         u8 sensb_res[NFC_SENSB_RES_MAXSIZE];
  81         u8 sensf_res_len;
  82         u8 sensf_res[NFC_SENSF_RES_MAXSIZE];
  83         u8 hci_reader_gate;
  84         u8 logical_idx;
  85 };
  86
  87 struct nfc_genl_data {
  88         u32 poll_req_pid;
  89         struct mutex genl_data_mutex;
  90 };
  91
  92 struct nfc_dev {
  93         unsigned int idx;
  94         u32 target_next_idx;
  95         struct nfc_target *targets;
  96         int n_targets;
  97         int targets_generation;
  98         spinlock_t targets_lock;
  99         struct device dev;
 100         bool dev_up;
 101         bool polling;
 102         u32 activated_target_idx;
 103         bool dep_link_up;
 104         u32 dep_rf_mode;
 105         struct nfc_genl_data genl_data;
 106         u32 supported_protocols;
 107
 108         int tx_headroom;
 109         int tx_tailroom;
 110
 111         struct timer_list check_pres_timer;
 112         struct workqueue_struct *check_pres_wq;
 113         struct work_struct check_pres_work;
 114
 115         struct nfc_ops *ops;
 116 };
 117 #define to_nfc_dev(_dev) container_of(_dev, struct nfc_dev, dev)
 118
 119 extern struct class nfc_class;
 120
 121 struct nfc_dev *nfc_allocate_device(struct nfc_ops *ops,
 122                                     u32 supported_protocols,
 123                                     int tx_headroom,
 124                                     int tx_tailroom);
 125
 126 /**
 127  * nfc_free_device - free nfc device
 128  *
 129  * @dev: The nfc device to free
 130  */
 131 static inline void nfc_free_device(struct nfc_dev *dev)
 132 {
 133         put_device(&dev->dev);
 134 }
 135
 136 int nfc_register_device(struct nfc_dev *dev);
 137
 138 void nfc_unregister_device(struct nfc_dev *dev);
 139
 140 /**
 141  * nfc_set_parent_dev - set the parent device
 142  *
 143  * @nfc_dev: The nfc device whose parent is being set
 144  * @dev: The parent device
 145  */
 146 static inline void nfc_set_parent_dev(struct nfc_dev *nfc_dev,
 147                                       struct device *dev)
 148 {
 149         nfc_dev->dev.parent = dev;
 150 }
 151
 152 /**
 153  * nfc_set_drvdata - set driver specifc data
 154  *
 155  * @dev: The nfc device
 156  * @data: Pointer to driver specifc data
 157  */
 158 static inline void nfc_set_drvdata(struct nfc_dev *dev, void *data)
 159 {
 160         dev_set_drvdata(&dev->dev, data);
 161 }
 162
 163 /**
 164  * nfc_get_drvdata - get driver specifc data
 165  *
 166  * @dev: The nfc device
 167  */
 168 static inline void *nfc_get_drvdata(struct nfc_dev *dev)
 169 {
 170         return dev_get_drvdata(&dev->dev);
 171 }
 172
 173 /**
 174  * nfc_device_name - get the nfc device name
 175  *
 176  * @dev: The nfc device whose name to return
 177  */
 178 static inline const char *nfc_device_name(struct nfc_dev *dev)
 179 {
 180         return dev_name(&dev->dev);
 181 }
 182
 183 struct sk_buff *nfc_alloc_send_skb(struct nfc_dev *dev, struct sock *sk,
 184                                    unsigned int flags, unsigned int size,
 185                                    unsigned int *err);
 186 struct sk_buff *nfc_alloc_recv_skb(unsigned int size, gfp_t gfp);
 187
 188 int nfc_set_remote_general_bytes(struct nfc_dev *dev,
 189                                  u8 *gt, u8 gt_len);
 190
 191 int nfc_targets_found(struct nfc_dev *dev,
 192                       struct nfc_target *targets, int ntargets);
 193 int nfc_target_lost(struct nfc_dev *dev, u32 target_idx);
 194
 195 int nfc_dep_link_is_up(struct nfc_dev *dev, u32 target_idx,
 196                        u8 comm_mode, u8 rf_mode);
 197
 198 #endif /* __NET_NFC_H */