drivers/nfc/nfcmrvl/uart.c

   1 /**
   2  * Marvell NFC-over-UART driver
   3  *
   4  * Copyright (C) 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 #include <linux/module.h>
  20 #include <linux/delay.h>
  21 #include <linux/of_gpio.h>
  22 #include <net/nfc/nci.h>
  23 #include <net/nfc/nci_core.h>
  24 #include "nfcmrvl.h"
  25
  26 static unsigned int hci_muxed;
  27 static unsigned int flow_control;
  28 static unsigned int break_control;
  29 static unsigned int reset_n_io;
  30
  31 /*
  32 ** NFCMRVL NCI OPS
  33 */
  34
  35 static int nfcmrvl_uart_nci_open(struct nfcmrvl_private *priv)
  36 {
  37         return 0;
  38 }
  39
  40 static int nfcmrvl_uart_nci_close(struct nfcmrvl_private *priv)
  41 {
  42         return 0;
  43 }
  44
  45 static int nfcmrvl_uart_nci_send(struct nfcmrvl_private *priv,
  46                                  struct sk_buff *skb)
  47 {
  48         struct nci_uart *nu = priv->drv_data;
  49
  50         return nu->ops.send(nu, skb);
  51 }
  52
  53 static void nfcmrvl_uart_nci_update_config(struct nfcmrvl_private *priv,
  54                                            const void *param)
  55 {
  56         struct nci_uart *nu = priv->drv_data;
  57         const struct nfcmrvl_fw_uart_config *config = param;
  58
  59         nci_uart_set_config(nu, le32_to_cpu(config->baudrate),
  60                             config->flow_control);
  61 }
  62
  63 static struct nfcmrvl_if_ops uart_ops = {
  64         .nci_open = nfcmrvl_uart_nci_open,
  65         .nci_close = nfcmrvl_uart_nci_close,
  66         .nci_send = nfcmrvl_uart_nci_send,
  67         .nci_update_config = nfcmrvl_uart_nci_update_config
  68 };
  69
  70 static int nfcmrvl_uart_parse_dt(struct device_node *node,
  71                                  struct nfcmrvl_platform_data *pdata)
  72 {
  73         struct device_node *matched_node;
  74         int ret;
  75
  76         matched_node = of_get_compatible_child(node, "marvell,nfc-uart");
  77         if (!matched_node) {
  78                 matched_node = of_get_compatible_child(node, "mrvl,nfc-uart");
  79                 if (!matched_node)
  80                         return -ENODEV;
  81         }
  82
  83         ret = nfcmrvl_parse_dt(matched_node, pdata);
  84         if (ret < 0) {
  85                 pr_err("Failed to get generic entries\n");
  86                 return ret;
  87         }
  88
  89         if (of_find_property(matched_node, "flow-control", NULL))
  90                 pdata->flow_control = 1;
  91         else
  92                 pdata->flow_control = 0;
  93
  94         if (of_find_property(matched_node, "break-control", NULL))
  95                 pdata->break_control = 1;
  96         else
  97                 pdata->break_control = 0;
  98
  99         return 0;
 100 }
 101
 102 /*
 103 ** NCI UART OPS
 104 */
 105
 106 static int nfcmrvl_nci_uart_open(struct nci_uart *nu)
 107 {
 108         struct nfcmrvl_private *priv;
 109         struct nfcmrvl_platform_data *pdata = NULL;
 110         struct nfcmrvl_platform_data config;
 111         struct device *dev = nu->tty->dev;
 112
 113         /*
 114          * Platform data cannot be used here since usually it is already used
 115          * by low level serial driver. We can try to retrieve serial device
 116          * and check if DT entries were added.
 117          */
 118
 119         if (dev && dev->parent && dev->parent->of_node)
 120                 if (nfcmrvl_uart_parse_dt(dev->parent->of_node, &config) == 0)
 121                         pdata = &config;
 122
 123         if (!pdata) {
 124                 pr_info("No platform data / DT -> fallback to module params\n");
 125                 config.hci_muxed = hci_muxed;
 126                 config.reset_n_io = reset_n_io;
 127                 config.flow_control = flow_control;
 128                 config.break_control = break_control;
 129                 pdata = &config;
 130         }
 131
 132         priv = nfcmrvl_nci_register_dev(NFCMRVL_PHY_UART, nu, &uart_ops,
 133                                         dev, pdata);
 134         if (IS_ERR(priv))
 135                 return PTR_ERR(priv);
 136
 137         priv->support_fw_dnld = true;
 138
 139         nu->drv_data = priv;
 140         nu->ndev = priv->ndev;
 141
 142         return 0;
 143 }
 144
 145 static void nfcmrvl_nci_uart_close(struct nci_uart *nu)
 146 {
 147         nfcmrvl_nci_unregister_dev((struct nfcmrvl_private *)nu->drv_data);
 148 }
 149
 150 static int nfcmrvl_nci_uart_recv(struct nci_uart *nu, struct sk_buff *skb)
 151 {
 152         return nfcmrvl_nci_recv_frame((struct nfcmrvl_private *)nu->drv_data,
 153                                       skb);
 154 }
 155
 156 static void nfcmrvl_nci_uart_tx_start(struct nci_uart *nu)
 157 {
 158         struct nfcmrvl_private *priv = (struct nfcmrvl_private *)nu->drv_data;
 159
 160         if (priv->ndev->nfc_dev->fw_download_in_progress)
 161                 return;
 162
 163         /* Remove BREAK to wake up the NFCC */
 164         if (priv->config.break_control && nu->tty->ops->break_ctl) {
 165                 nu->tty->ops->break_ctl(nu->tty, 0);
 166                 usleep_range(3000, 5000);
 167         }
 168 }
 169
 170 static void nfcmrvl_nci_uart_tx_done(struct nci_uart *nu)
 171 {
 172         struct nfcmrvl_private *priv = (struct nfcmrvl_private *)nu->drv_data;
 173
 174         if (priv->ndev->nfc_dev->fw_download_in_progress)
 175                 return;
 176
 177         /*
 178         ** To ensure that if the NFCC goes in DEEP SLEEP sate we can wake him
 179         ** up. we set BREAK. Once we will be ready to send again we will remove
 180         ** it.
 181         */
 182         if (priv->config.break_control && nu->tty->ops->break_ctl) {
 183                 nu->tty->ops->break_ctl(nu->tty, -1);
 184                 usleep_range(1000, 3000);
 185         }
 186 }
 187
 188 static struct nci_uart nfcmrvl_nci_uart = {
 189         .owner  = THIS_MODULE,
 190         .name   = "nfcmrvl_uart",
 191         .driver = NCI_UART_DRIVER_MARVELL,
 192         .ops    = {
 193                 .open           = nfcmrvl_nci_uart_open,
 194                 .close          = nfcmrvl_nci_uart_close,
 195                 .recv           = nfcmrvl_nci_uart_recv,
 196                 .tx_start       = nfcmrvl_nci_uart_tx_start,
 197                 .tx_done        = nfcmrvl_nci_uart_tx_done,
 198         }
 199 };
 200
 201 /*
 202 ** Module init
 203 */
 204
 205 static int nfcmrvl_uart_init_module(void)
 206 {
 207         return nci_uart_register(&nfcmrvl_nci_uart);
 208 }
 209
 210 static void nfcmrvl_uart_exit_module(void)
 211 {
 212         nci_uart_unregister(&nfcmrvl_nci_uart);
 213 }
 214
 215 module_init(nfcmrvl_uart_init_module);
 216 module_exit(nfcmrvl_uart_exit_module);
 217
 218 MODULE_AUTHOR("Marvell International Ltd.");
 219 MODULE_DESCRIPTION("Marvell NFC-over-UART");
 220 MODULE_LICENSE("GPL v2");
 221
 222 module_param(flow_control, uint, 0);
 223 MODULE_PARM_DESC(flow_control, "Tell if UART needs flow control at init.");
 224
 225 module_param(break_control, uint, 0);
 226 MODULE_PARM_DESC(break_control, "Tell if UART driver must drive break signal.");
 227
 228 module_param(hci_muxed, uint, 0);
 229 MODULE_PARM_DESC(hci_muxed, "Tell if transport is muxed in HCI one.");
 230
 231 module_param(reset_n_io, uint, 0);
 232 MODULE_PARM_DESC(reset_n_io, "GPIO that is wired to RESET_N signal.");