LXR linux/include/net/nfc/nci

   1/*
   2 *  The NFC Controller Interface is the communication protocol between an
   3 *  NFC Controller (NFCC) and a Device Host (DH).
   4 *
   5 *  Copyright (C) 2011 Texas Instruments, Inc.
   6 *
   7 *  Written by Ilan Elias <ilane@ti.com>
   8 *
   9 *  Acknowledgements:
  10 *  This file is based on hci_core.h, which was written
  11 *  by Maxim Krasnyansky.
  12 *
  13 *  This program is free software; you can redistribute it and/or modify
  14 *  it under the terms of the GNU General Public License version 2
  15 *  as published by the Free Software Foundation
  16 *
  17 *  This program is distributed in the hope that it will be useful,
  18 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 *  GNU General Public License for more details.
  21 *
  22 *  You should have received a copy of the GNU General Public License
  23 *  along with this program; if not, write to the Free Software
  24 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  25 *
  26 */
  27
  28#ifndef __NCI_CORE_H
  29#define __NCI_CORE_H
  30
  31#include <linux/interrupt.h>
  32#include <linux/skbuff.h>
  33
  34#include <net/nfc/nfc.h>
  35#include <net/nfc/nci.h>
  36
  37/* NCI device state */
  38enum {
  39        NCI_INIT,
  40        NCI_UP,
  41        NCI_DISCOVERY,
  42        NCI_POLL_ACTIVE,
  43        NCI_DATA_EXCHANGE,
  44};
  45
  46/* NCI timeouts */
  47#define NCI_RESET_TIMEOUT                       5000
  48#define NCI_INIT_TIMEOUT                        5000
  49#define NCI_RF_DISC_TIMEOUT                     5000
  50#define NCI_RF_DEACTIVATE_TIMEOUT               5000
  51#define NCI_CMD_TIMEOUT                         5000
  52
  53struct nci_dev;
  54
  55struct nci_ops {
  56        int (*open)(struct nci_dev *ndev);
  57        int (*close)(struct nci_dev *ndev);
  58        int (*send)(struct sk_buff *skb);
  59};
  60
  61#define NCI_MAX_SUPPORTED_RF_INTERFACES         4
  62
  63/* NCI Core structures */
  64struct nci_dev {
  65        struct nfc_dev          *nfc_dev;
  66        struct nci_ops          *ops;
  67
  68        int                     tx_headroom;
  69        int                     tx_tailroom;
  70
  71        unsigned long           flags;
  72
  73        atomic_t                cmd_cnt;
  74        atomic_t                credits_cnt;
  75
  76        struct timer_list       cmd_timer;
  77
  78        struct workqueue_struct *cmd_wq;
  79        struct work_struct      cmd_work;
  80
  81        struct workqueue_struct *rx_wq;
  82        struct work_struct      rx_work;
  83
  84        struct workqueue_struct *tx_wq;
  85        struct work_struct      tx_work;
  86
  87        struct sk_buff_head     cmd_q;
  88        struct sk_buff_head     rx_q;
  89        struct sk_buff_head     tx_q;
  90
  91        struct mutex            req_lock;
  92        struct completion       req_completion;
  93        __u32                   req_status;
  94        __u32                   req_result;
  95
  96        void                    *driver_data;
  97
  98        __u32                   poll_prots;
  99        __u32                   target_available_prots;
 100        __u32                   target_active_prot;
 101
 102        /* received during NCI_OP_CORE_RESET_RSP */
 103        __u8                    nci_ver;
 104
 105        /* received during NCI_OP_CORE_INIT_RSP */
 106        __u32                   nfcc_features;
 107        __u8                    num_supported_rf_interfaces;
 108        __u8                    supported_rf_interfaces
 109                                [NCI_MAX_SUPPORTED_RF_INTERFACES];
 110        __u8                    max_logical_connections;
 111        __u16                   max_routing_table_size;
 112        __u8                    max_ctrl_pkt_payload_len;
 113        __u16                   max_size_for_large_params;
 114        __u8                    manufact_id;
 115        __u32                   manufact_specific_info;
 116
 117        /* received during NCI_OP_RF_INTF_ACTIVATED_NTF */
 118        __u8                    max_data_pkt_payload_size;
 119        __u8                    initial_num_credits;
 120
 121        /* stored during nci_data_exchange */
 122        data_exchange_cb_t      data_exchange_cb;
 123        void                    *data_exchange_cb_context;
 124        struct sk_buff          *rx_data_reassembly;
 125};
 126
 127/* ----- NCI Devices ----- */
 128struct nci_dev *nci_allocate_device(struct nci_ops *ops,
 129                                __u32 supported_protocols,
 130                                int tx_headroom,
 131                                int tx_tailroom);
 132void nci_free_device(struct nci_dev *ndev);
 133int nci_register_device(struct nci_dev *ndev);
 134void nci_unregister_device(struct nci_dev *ndev);
 135int nci_recv_frame(struct sk_buff *skb);
 136
 137static inline struct sk_buff *nci_skb_alloc(struct nci_dev *ndev,
 138                                                unsigned int len,
 139                                                gfp_t how)
 140{
 141        struct sk_buff *skb;
 142
 143        skb = alloc_skb(len + ndev->tx_headroom + ndev->tx_tailroom, how);
 144        if (skb)
 145                skb_reserve(skb, ndev->tx_headroom);
 146
 147        return skb;
 148}
 149
 150static inline void nci_set_parent_dev(struct nci_dev *ndev, struct device *dev)
 151{
 152        nfc_set_parent_dev(ndev->nfc_dev, dev);
 153}
 154
 155static inline void nci_set_drvdata(struct nci_dev *ndev, void *data)
 156{
 157        ndev->driver_data = data;
 158}
 159
 160static inline void *nci_get_drvdata(struct nci_dev *ndev)
 161{
 162        return ndev->driver_data;
 163}
 164
 165void nci_rsp_packet(struct nci_dev *ndev, struct sk_buff *skb);
 166void nci_ntf_packet(struct nci_dev *ndev, struct sk_buff *skb);
 167void nci_rx_data_packet(struct nci_dev *ndev, struct sk_buff *skb);
 168int nci_send_cmd(struct nci_dev *ndev, __u16 opcode, __u8 plen, void *payload);
 169int nci_send_data(struct nci_dev *ndev, __u8 conn_id, struct sk_buff *skb);
 170void nci_data_exchange_complete(struct nci_dev *ndev, struct sk_buff *skb,
 171                                int err);
 172
 173/* ----- NCI requests ----- */
 174#define NCI_REQ_DONE            0
 175#define NCI_REQ_PEND            1
 176#define NCI_REQ_CANCELED        2
 177
 178void nci_req_complete(struct nci_dev *ndev, int result);
 179
 180/* ----- NCI status code ----- */
 181int nci_to_errno(__u8 code);
 182
 183#endif /* __NCI_CORE_H */
 184