LXR linux/include/net/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 (*start_poll)(struct nfc_dev *dev, u32 protocols);
  52        void (*stop_poll)(struct nfc_dev *dev);
  53        int (*activate_target)(struct nfc_dev *dev, u32 target_idx,
  54                                                        u32 protocol);
  55        void (*deactivate_target)(struct nfc_dev *dev, u32 target_idx);
  56        int (*data_exchange)(struct nfc_dev *dev, u32 target_idx,
  57                                struct sk_buff *skb, data_exchange_cb_t cb,
  58                                                        void *cb_context);
  59};
  60
  61struct nfc_target {
  62        u32 idx;
  63        u32 supported_protocols;
  64        u16 sens_res;
  65        u8 sel_res;
  66};
  67
  68struct nfc_genl_data {
  69        u32 poll_req_pid;
  70        struct mutex genl_data_mutex;
  71};
  72
  73struct nfc_dev {
  74        unsigned idx;
  75        unsigned target_idx;
  76        struct nfc_target *targets;
  77        int n_targets;
  78        int targets_generation;
  79        spinlock_t targets_lock;
  80        struct device dev;
  81        bool polling;
  82        struct nfc_genl_data genl_data;
  83        u32 supported_protocols;
  84
  85        struct nfc_ops *ops;
  86};
  87#define to_nfc_dev(_dev) container_of(_dev, struct nfc_dev, dev)
  88
  89extern struct class nfc_class;
  90
  91struct nfc_dev *nfc_allocate_device(struct nfc_ops *ops,
  92                                        u32 supported_protocols);
  93
  94/**
  95 * nfc_free_device - free nfc device
  96 *
  97 * @dev: The nfc device to free
  98 */
  99static inline void nfc_free_device(struct nfc_dev *dev)
 100{
 101        put_device(&dev->dev);
 102}
 103
 104int nfc_register_device(struct nfc_dev *dev);
 105
 106void nfc_unregister_device(struct nfc_dev *dev);
 107
 108/**
 109 * nfc_set_parent_dev - set the parent device
 110 *
 111 * @nfc_dev: The nfc device whose parent is being set
 112 * @dev: The parent device
 113 */
 114static inline void nfc_set_parent_dev(struct nfc_dev *nfc_dev,
 115                                        struct device *dev)
 116{
 117        nfc_dev->dev.parent = dev;
 118}
 119
 120/**
 121 * nfc_set_drvdata - set driver specifc data
 122 *
 123 * @dev: The nfc device
 124 * @data: Pointer to driver specifc data
 125 */
 126static inline void nfc_set_drvdata(struct nfc_dev *dev, void *data)
 127{
 128        dev_set_drvdata(&dev->dev, data);
 129}
 130
 131/**
 132 * nfc_get_drvdata - get driver specifc data
 133 *
 134 * @dev: The nfc device
 135 */
 136static inline void *nfc_get_drvdata(struct nfc_dev *dev)
 137{
 138        return dev_get_drvdata(&dev->dev);
 139}
 140
 141/**
 142 * nfc_device_name - get the nfc device name
 143 *
 144 * @dev: The nfc device whose name to return
 145 */
 146static inline const char *nfc_device_name(struct nfc_dev *dev)
 147{
 148        return dev_name(&dev->dev);
 149}
 150
 151struct sk_buff *nfc_alloc_skb(unsigned int size, gfp_t gfp);
 152
 153int nfc_targets_found(struct nfc_dev *dev, struct nfc_target *targets,
 154                                                        int ntargets);
 155
 156#endif /* __NET_NFC_H */
 157