drivers/nfc/nfcmrvl/nfcmrvl.h

   1 /**
   2  * Marvell NFC driver
   3  *
   4  * Copyright (C) 2014-2015, Marvell International Ltd.
   5  *
   6  * This software file (the "File") is distributed by Marvell International
   7  * Ltd. under the terms of the GNU General Public License Version 2, June 1991
   8  * (the "License").  You may use, redistribute and/or modify this File in
   9  * accordance with the terms and conditions of the License, a copy of which
  10  * is available on the worldwide web at
  11  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
  12  *
  13  * THE FILE IS DISTRIBUTED AS-IS, WITHOUT WARRANTY OF ANY KIND, AND THE
  14  * IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE
  15  * ARE EXPRESSLY DISCLAIMED.  The License provides additional details about
  16  * this warranty disclaimer.
  17  **/
  18
  19 #ifndef _NFCMRVL_H_
  20 #define _NFCMRVL_H_
  21
  22 #include <linux/platform_data/nfcmrvl.h>
  23
  24 #include "fw_dnld.h"
  25
  26 /* Define private flags: */
  27 #define NFCMRVL_NCI_RUNNING                     1
  28
  29 #define NFCMRVL_EXT_COEX_ID                     0xE0
  30 #define NFCMRVL_NOT_ALLOWED_ID                  0xE1
  31 #define NFCMRVL_ACTIVE_ID                       0xE2
  32 #define NFCMRVL_EXT_COEX_ENABLE                 1
  33 #define NFCMRVL_GPIO_PIN_NFC_NOT_ALLOWED        0xA
  34 #define NFCMRVL_GPIO_PIN_NFC_ACTIVE             0xB
  35 #define NFCMRVL_NCI_MAX_EVENT_SIZE              260
  36
  37 /*
  38 ** NCI FW Parmaters
  39 */
  40
  41 #define NFCMRVL_PB_BAIL_OUT                     0x11
  42 #define NFCMRVL_PROP_REF_CLOCK                  0xF0
  43 #define NFCMRVL_PROP_SET_HI_CONFIG              0xF1
  44
  45 /*
  46 ** HCI defines
  47 */
  48
  49 #define NFCMRVL_HCI_EVENT_HEADER_SIZE           0x04
  50 #define NFCMRVL_HCI_EVENT_CODE                  0x04
  51 #define NFCMRVL_HCI_NFC_EVENT_CODE              0xFF
  52 #define NFCMRVL_HCI_COMMAND_CODE                0x01
  53 #define NFCMRVL_HCI_OGF                         0x81
  54 #define NFCMRVL_HCI_OCF                         0xFE
  55
  56 enum nfcmrvl_phy {
  57         NFCMRVL_PHY_USB         = 0,
  58         NFCMRVL_PHY_UART        = 1,
  59         NFCMRVL_PHY_I2C         = 2,
  60         NFCMRVL_PHY_SPI         = 3,
  61 };
  62
  63 struct nfcmrvl_private {
  64
  65         unsigned long flags;
  66
  67         /* Platform configuration */
  68         struct nfcmrvl_platform_data config;
  69
  70         /* Parent dev */
  71         struct nci_dev *ndev;
  72
  73         /* FW download context */
  74         struct nfcmrvl_fw_dnld fw_dnld;
  75
  76         /* FW download support */
  77         bool support_fw_dnld;
  78
  79         /*
  80         ** PHY related information
  81         */
  82
  83         /* PHY driver context */
  84         void *drv_data;
  85         /* PHY device */
  86         struct device *dev;
  87         /* PHY type */
  88         enum nfcmrvl_phy phy;
  89         /* Low level driver ops */
  90         struct nfcmrvl_if_ops *if_ops;
  91 };
  92
  93 struct nfcmrvl_if_ops {
  94         int (*nci_open) (struct nfcmrvl_private *priv);
  95         int (*nci_close) (struct nfcmrvl_private *priv);
  96         int (*nci_send) (struct nfcmrvl_private *priv, struct sk_buff *skb);
  97         void (*nci_update_config)(struct nfcmrvl_private *priv,
  98                                   const void *param);
  99 };
 100
 101 void nfcmrvl_nci_unregister_dev(struct nfcmrvl_private *priv);
 102 int nfcmrvl_nci_recv_frame(struct nfcmrvl_private *priv, struct sk_buff *skb);
 103 struct nfcmrvl_private *nfcmrvl_nci_register_dev(void *drv_data,
 104                                 struct nfcmrvl_if_ops *ops,
 105                                 struct device *dev,
 106                                 struct nfcmrvl_platform_data *pdata);
 107
 108
 109 void nfcmrvl_chip_reset(struct nfcmrvl_private *priv);
 110 void nfcmrvl_chip_halt(struct nfcmrvl_private *priv);
 111
 112 int nfcmrvl_parse_dt(struct device_node *node,
 113                      struct nfcmrvl_platform_data *pdata);
 114
 115 #endif