LXR linux/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
  35struct 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 */
  48typedef void (*data_exchange_cb_t)(void *context, struct sk_buff *skb,
  49                                                                int err);
  50
  51struct nfc_target;
  52
  53struct 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 (*enable_se)(struct nfc_dev *dev, u32 secure_element);
  72        int (*disable_se)(struct nfc_dev *dev, u32 secure_element);
  73};
  74
  75#define NFC_TARGET_IDX_ANY -1
  76#define NFC_MAX_GT_LEN 48
  77#define NFC_ATR_RES_GT_OFFSET 15
  78
  79struct nfc_target {
  80        u32 idx;
  81        u32 supported_protocols;
  82        u16 sens_res;
  83        u8 sel_res;
  84        u8 nfcid1_len;
  85        u8 nfcid1[NFC_NFCID1_MAXSIZE];
  86        u8 sensb_res_len;
  87        u8 sensb_res[NFC_SENSB_RES_MAXSIZE];
  88        u8 sensf_res_len;
  89        u8 sensf_res[NFC_SENSF_RES_MAXSIZE];
  90        u8 hci_reader_gate;
  91        u8 logical_idx;
  92};
  93
  94struct nfc_genl_data {
  95        u32 poll_req_portid;
  96        struct mutex genl_data_mutex;
  97};
  98
  99struct nfc_dev {
 100        int idx;
 101        u32 target_next_idx;
 102        struct nfc_target *targets;
 103        int n_targets;
 104        int targets_generation;
 105        struct device dev;
 106        bool dev_up;
 107        u8 rf_mode;
 108        bool polling;
 109        struct nfc_target *active_target;
 110        bool dep_link_up;
 111        struct nfc_genl_data genl_data;
 112        u32 supported_protocols;
 113
 114        u32 supported_se;
 115        u32 active_se;
 116
 117        int tx_headroom;
 118        int tx_tailroom;
 119
 120        struct timer_list check_pres_timer;
 121        struct work_struct check_pres_work;
 122
 123        bool shutting_down;
 124
 125        struct nfc_ops *ops;
 126};
 127#define to_nfc_dev(_dev) container_of(_dev, struct nfc_dev, dev)
 128
 129extern struct class nfc_class;
 130
 131struct nfc_dev *nfc_allocate_device(struct nfc_ops *ops,
 132                                    u32 supported_protocols,
 133                                    u32 supported_se,
 134                                    int tx_headroom,
 135                                    int tx_tailroom);
 136
 137/**
 138 * nfc_free_device - free nfc device
 139 *
 140 * @dev: The nfc device to free
 141 */
 142static inline void nfc_free_device(struct nfc_dev *dev)
 143{
 144        put_device(&dev->dev);
 145}
 146
 147int nfc_register_device(struct nfc_dev *dev);
 148
 149void nfc_unregister_device(struct nfc_dev *dev);
 150
 151/**
 152 * nfc_set_parent_dev - set the parent device
 153 *
 154 * @nfc_dev: The nfc device whose parent is being set
 155 * @dev: The parent device
 156 */
 157static inline void nfc_set_parent_dev(struct nfc_dev *nfc_dev,
 158                                      struct device *dev)
 159{
 160        nfc_dev->dev.parent = dev;
 161}
 162
 163/**
 164 * nfc_set_drvdata - set driver specifc data
 165 *
 166 * @dev: The nfc device
 167 * @data: Pointer to driver specifc data
 168 */
 169static inline void nfc_set_drvdata(struct nfc_dev *dev, void *data)
 170{
 171        dev_set_drvdata(&dev->dev, data);
 172}
 173
 174/**
 175 * nfc_get_drvdata - get driver specifc data
 176 *
 177 * @dev: The nfc device
 178 */
 179static inline void *nfc_get_drvdata(struct nfc_dev *dev)
 180{
 181        return dev_get_drvdata(&dev->dev);
 182}
 183
 184/**
 185 * nfc_device_name - get the nfc device name
 186 *
 187 * @dev: The nfc device whose name to return
 188 */
 189static inline const char *nfc_device_name(struct nfc_dev *dev)
 190{
 191        return dev_name(&dev->dev);
 192}
 193
 194struct sk_buff *nfc_alloc_send_skb(struct nfc_dev *dev, struct sock *sk,
 195                                   unsigned int flags, unsigned int size,
 196                                   unsigned int *err);
 197struct sk_buff *nfc_alloc_recv_skb(unsigned int size, gfp_t gfp);
 198
 199int nfc_set_remote_general_bytes(struct nfc_dev *dev,
 200                                 u8 *gt, u8 gt_len);
 201u8 *nfc_get_local_general_bytes(struct nfc_dev *dev, size_t *gb_len);
 202
 203int nfc_targets_found(struct nfc_dev *dev,
 204                      struct nfc_target *targets, int ntargets);
 205int nfc_target_lost(struct nfc_dev *dev, u32 target_idx);
 206
 207int nfc_dep_link_is_up(struct nfc_dev *dev, u32 target_idx,
 208                       u8 comm_mode, u8 rf_mode);
 209
 210int nfc_tm_activated(struct nfc_dev *dev, u32 protocol, u8 comm_mode,
 211                     u8 *gb, size_t gb_len);
 212int nfc_tm_deactivated(struct nfc_dev *dev);
 213int nfc_tm_data_received(struct nfc_dev *dev, struct sk_buff *skb);
 214
 215void nfc_driver_failure(struct nfc_dev *dev, int err);
 216
 217#endif /* __NET_NFC_H */
 218