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/device.h>
  28#include <linux/skbuff.h>
  29
  30#define nfc_dev_info(dev, fmt, arg...) dev_info((dev), "NFC: " fmt "\n", ## arg)
  31#define nfc_dev_err(dev, fmt, arg...) dev_err((dev), "NFC: " fmt "\n", ## arg)
  32#define nfc_dev_dbg(dev, fmt, arg...) dev_dbg((dev), fmt "\n", ## arg)
  33
  34struct nfc_dev;
  35
  36/**
  37 * data_exchange_cb_t - Definition of nfc_data_exchange callback
  38 *
  39 * @context: nfc_data_exchange cb_context parameter
  40 * @skb: response data
  41 * @err: If an error has occurred during data exchange, it is the
  42 *      error number. Zero means no error.
  43 *
  44 * When a rx or tx package is lost or corrupted or the target gets out
  45 * of the operating field, err is -EIO.
  46 */
  47typedef void (*data_exchange_cb_t)(void *context, struct sk_buff *skb,
  48                                                                int err);
  49
  50struct nfc_ops {
  51        int (*dev_up)(struct nfc_dev *dev);
  52        int (*dev_down)(struct nfc_dev *dev);
  53        int (*start_poll)(struct nfc_dev *dev, u32 protocols);
  54        void (*stop_poll)(struct nfc_dev *dev);
  55        int (*dep_link_up)(struct nfc_dev *dev, int target_idx,
  56                                u8 comm_mode, u8 rf_mode);
  57        int (*dep_link_down)(struct nfc_dev *dev);
  58        int (*activate_target)(struct nfc_dev *dev, u32 target_idx,
  59                                                        u32 protocol);
  60        void (*deactivate_target)(struct nfc_dev *dev, u32 target_idx);
  61        int (*data_exchange)(struct nfc_dev *dev, u32 target_idx,
  62                                struct sk_buff *skb, data_exchange_cb_t cb,
  63                                                        void *cb_context);
  64};
  65
  66#define NFC_TARGET_IDX_ANY -1
  67#define NFC_MAX_GT_LEN 48
  68#define NFC_MAX_NFCID1_LEN 10
  69
  70struct nfc_target {
  71        u32 idx;
  72        u32 supported_protocols;
  73        u16 sens_res;
  74        u8 sel_res;
  75        u8 nfcid1_len;
  76        u8 nfcid1[NFC_MAX_NFCID1_LEN];
  77};
  78
  79struct nfc_genl_data {
  80        u32 poll_req_pid;
  81        struct mutex genl_data_mutex;
  82};
  83
  84struct nfc_dev {
  85        unsigned idx;
  86        unsigned target_idx;
  87        struct nfc_target *targets;
  88        int n_targets;
  89        int targets_generation;
  90        spinlock_t targets_lock;
  91        struct device dev;
  92        bool dev_up;
  93        bool polling;
  94        bool remote_activated;
  95        bool dep_link_up;
  96        u32 dep_rf_mode;
  97        struct nfc_genl_data genl_data;
  98        u32 supported_protocols;
  99
 100        int tx_headroom;
 101        int tx_tailroom;
 102
 103        struct nfc_ops *ops;
 104};
 105#define to_nfc_dev(_dev) container_of(_dev, struct nfc_dev, dev)
 106
 107extern struct class nfc_class;
 108
 109struct nfc_dev *nfc_allocate_device(struct nfc_ops *ops,
 110                                        u32 supported_protocols,
 111                                        int tx_headroom,
 112                                        int tx_tailroom);
 113
 114/**
 115 * nfc_free_device - free nfc device
 116 *
 117 * @dev: The nfc device to free
 118 */
 119static inline void nfc_free_device(struct nfc_dev *dev)
 120{
 121        put_device(&dev->dev);
 122}
 123
 124int nfc_register_device(struct nfc_dev *dev);
 125
 126void nfc_unregister_device(struct nfc_dev *dev);
 127
 128/**
 129 * nfc_set_parent_dev - set the parent device
 130 *
 131 * @nfc_dev: The nfc device whose parent is being set
 132 * @dev: The parent device
 133 */
 134static inline void nfc_set_parent_dev(struct nfc_dev *nfc_dev,
 135                                        struct device *dev)
 136{
 137        nfc_dev->dev.parent = dev;
 138}
 139
 140/**
 141 * nfc_set_drvdata - set driver specifc data
 142 *
 143 * @dev: The nfc device
 144 * @data: Pointer to driver specifc data
 145 */
 146static inline void nfc_set_drvdata(struct nfc_dev *dev, void *data)
 147{
 148        dev_set_drvdata(&dev->dev, data);
 149}
 150
 151/**
 152 * nfc_get_drvdata - get driver specifc data
 153 *
 154 * @dev: The nfc device
 155 */
 156static inline void *nfc_get_drvdata(struct nfc_dev *dev)
 157{
 158        return dev_get_drvdata(&dev->dev);
 159}
 160
 161/**
 162 * nfc_device_name - get the nfc device name
 163 *
 164 * @dev: The nfc device whose name to return
 165 */
 166static inline const char *nfc_device_name(struct nfc_dev *dev)
 167{
 168        return dev_name(&dev->dev);
 169}
 170
 171struct sk_buff *nfc_alloc_send_skb(struct nfc_dev *dev, struct sock *sk,
 172                                        unsigned int flags, unsigned int size,
 173                                        unsigned int *err);
 174struct sk_buff *nfc_alloc_recv_skb(unsigned int size, gfp_t gfp);
 175
 176int nfc_set_remote_general_bytes(struct nfc_dev *dev,
 177                                        u8 *gt, u8 gt_len);
 178
 179u8 *nfc_get_local_general_bytes(struct nfc_dev *dev, u8 *gt_len);
 180
 181int nfc_targets_found(struct nfc_dev *dev, struct nfc_target *targets,
 182                                                        int ntargets);
 183
 184int nfc_dep_link_is_up(struct nfc_dev *dev, u32 target_idx,
 185                       u8 comm_mode, u8 rf_mode);
 186
 187#endif /* __NET_NFC_H */
 188