include/net/nfc/nci

/* [<][>][^][v][top][bottom][index][help] */
This source file includes following definitions.
nci_skb_alloc
nci_set_parent_dev
nci_set_drvdata
nci_get_drvdata
/*
 *  The NFC Controller Interface is the communication protocol between an
 *  NFC Controller (NFCC) and a Device Host (DH).
 *
 *  Copyright (C) 2011 Texas Instruments, Inc.
 *  Copyright (C) 2013 Intel Corporation. All rights reserved.
 *
 *  Written by Ilan Elias <ilane@ti.com>
 *
 *  Acknowledgements:
 *  This file is based on hci_core.h, which was written
 *  by Maxim Krasnyansky.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License version 2
 *  as published by the Free Software Foundation
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef __NCI_CORE_H
#define __NCI_CORE_H

#include <linux/interrupt.h>
#include <linux/skbuff.h>

#include <net/nfc/nfc.h>
#include <net/nfc/nci.h>

/* NCI device flags */
enum nci_flag {
        NCI_INIT,
        NCI_UP,
        NCI_DATA_EXCHANGE,
        NCI_DATA_EXCHANGE_TO,
};

/* NCI device states */
enum nci_state {
        NCI_IDLE,
        NCI_DISCOVERY,
        NCI_W4_ALL_DISCOVERIES,
        NCI_W4_HOST_SELECT,
        NCI_POLL_ACTIVE,
};

/* NCI timeouts */
#define NCI_RESET_TIMEOUT                       5000
#define NCI_INIT_TIMEOUT                        5000
#define NCI_SET_CONFIG_TIMEOUT                  5000
#define NCI_RF_DISC_TIMEOUT                     5000
#define NCI_RF_DISC_SELECT_TIMEOUT              5000
#define NCI_RF_DEACTIVATE_TIMEOUT               30000
#define NCI_CMD_TIMEOUT                         5000
#define NCI_DATA_TIMEOUT                        700

struct nci_dev;

struct nci_ops {
        int   (*open)(struct nci_dev *ndev);
        int   (*close)(struct nci_dev *ndev);
        int   (*send)(struct nci_dev *ndev, struct sk_buff *skb);
        int   (*setup)(struct nci_dev *ndev);
        __u32 (*get_rfprotocol)(struct nci_dev *ndev, __u8 rf_protocol);
};

#define NCI_MAX_SUPPORTED_RF_INTERFACES         4
#define NCI_MAX_DISCOVERED_TARGETS              10

/* NCI Core structures */
struct nci_dev {
        struct nfc_dev          *nfc_dev;
        struct nci_ops          *ops;

        int                     tx_headroom;
        int                     tx_tailroom;

        atomic_t                state;
        unsigned long           flags;

        atomic_t                cmd_cnt;
        atomic_t                credits_cnt;

        struct timer_list       cmd_timer;
        struct timer_list       data_timer;

        struct workqueue_struct *cmd_wq;
        struct work_struct      cmd_work;

        struct workqueue_struct *rx_wq;
        struct work_struct      rx_work;

        struct workqueue_struct *tx_wq;
        struct work_struct      tx_work;

        struct sk_buff_head     cmd_q;
        struct sk_buff_head     rx_q;
        struct sk_buff_head     tx_q;

        struct mutex            req_lock;
        struct completion       req_completion;
        __u32                   req_status;
        __u32                   req_result;

        void                    *driver_data;

        __u32                   poll_prots;
        __u32                   target_active_prot;

        struct nfc_target       targets[NCI_MAX_DISCOVERED_TARGETS];
        int                     n_targets;

        /* received during NCI_OP_CORE_RESET_RSP */
        __u8                    nci_ver;

        /* received during NCI_OP_CORE_INIT_RSP */
        __u32                   nfcc_features;
        __u8                    num_supported_rf_interfaces;
        __u8                    supported_rf_interfaces
                                [NCI_MAX_SUPPORTED_RF_INTERFACES];
        __u8                    max_logical_connections;
        __u16                   max_routing_table_size;
        __u8                    max_ctrl_pkt_payload_len;
        __u16                   max_size_for_large_params;
        __u8                    manufact_id;
        __u32                   manufact_specific_info;

        /* received during NCI_OP_RF_INTF_ACTIVATED_NTF */
        __u8                    max_data_pkt_payload_size;
        __u8                    initial_num_credits;

        /* stored during nci_data_exchange */
        data_exchange_cb_t      data_exchange_cb;
        void                    *data_exchange_cb_context;
        struct sk_buff          *rx_data_reassembly;

        /* stored during intf_activated_ntf */
        __u8 remote_gb[NFC_MAX_GT_LEN];
        __u8 remote_gb_len;
};

/* ----- NCI Devices ----- */
struct nci_dev *nci_allocate_device(struct nci_ops *ops,
                                    __u32 supported_protocols,
                                    int tx_headroom,
                                    int tx_tailroom);
void nci_free_device(struct nci_dev *ndev);
int nci_register_device(struct nci_dev *ndev);
void nci_unregister_device(struct nci_dev *ndev);
int nci_recv_frame(struct nci_dev *ndev, struct sk_buff *skb);
int nci_set_config(struct nci_dev *ndev, __u8 id, size_t len, __u8 *val);

static inline struct sk_buff *nci_skb_alloc(struct nci_dev *ndev,
                                            unsigned int len,
                                            gfp_t how)
{
        struct sk_buff *skb;

        skb = alloc_skb(len + ndev->tx_headroom + ndev->tx_tailroom, how);
        if (skb)
                skb_reserve(skb, ndev->tx_headroom);

        return skb;
}

static inline void nci_set_parent_dev(struct nci_dev *ndev, struct device *dev)
{
        nfc_set_parent_dev(ndev->nfc_dev, dev);
}

static inline void nci_set_drvdata(struct nci_dev *ndev, void *data)
{
        ndev->driver_data = data;
}

static inline void *nci_get_drvdata(struct nci_dev *ndev)
{
        return ndev->driver_data;
}

void nci_rsp_packet(struct nci_dev *ndev, struct sk_buff *skb);
void nci_ntf_packet(struct nci_dev *ndev, struct sk_buff *skb);
void nci_rx_data_packet(struct nci_dev *ndev, struct sk_buff *skb);
int nci_send_cmd(struct nci_dev *ndev, __u16 opcode, __u8 plen, void *payload);
int nci_send_data(struct nci_dev *ndev, __u8 conn_id, struct sk_buff *skb);
void nci_data_exchange_complete(struct nci_dev *ndev, struct sk_buff *skb,
                                int err);
void nci_clear_target_list(struct nci_dev *ndev);

/* ----- NCI requests ----- */
#define NCI_REQ_DONE            0
#define NCI_REQ_PEND            1
#define NCI_REQ_CANCELED        2

void nci_req_complete(struct nci_dev *ndev, int result);

/* ----- NCI status code ----- */
int nci_to_errno(__u8 code);

/* ----- NCI over SPI acknowledge modes ----- */
#define NCI_SPI_CRC_DISABLED    0x00
#define NCI_SPI_CRC_ENABLED     0x01

/* ----- NCI SPI structures ----- */
struct nci_spi {
        struct nci_dev          *ndev;
        struct spi_device       *spi;

        unsigned int            xfer_udelay;    /* microseconds delay between
                                                  transactions */
        u8                      acknowledge_mode;

        struct completion       req_completion;
        u8                      req_result;
};

/* ----- NCI SPI ----- */
struct nci_spi *nci_spi_allocate_spi(struct spi_device *spi,
                                     u8 acknowledge_mode, unsigned int delay,
                                     struct nci_dev *ndev);
int nci_spi_send(struct nci_spi *nspi,
                 struct completion *write_handshake_completion,
                 struct sk_buff *skb);
struct sk_buff *nci_spi_read(struct nci_spi *nspi);

#endif /* __NCI_CORE_H */
/* [<][>][^][v][top][bottom][index][help] */
root/include/net/nfc/nci_core.h

DEFINITIONS
