nfc/nfcmrvl/main.c

0001 // SPDX-License-Identifier: GPL-2.0-only
0002 /*
0003  * Marvell NFC driver: major functions
0004  *
0005  * Copyright (C) 2014-2015 Marvell International Ltd.
0006  */
0007
0008 #include <linux/module.h>
0009 #include <linux/gpio.h>
0010 #include <linux/delay.h>
0011 #include <linux/of_gpio.h>
0012 #include <linux/nfc.h>
0013 #include <net/nfc/nci.h>
0014 #include <net/nfc/nci_core.h>
0015 #include "nfcmrvl.h"
0016
0017 static int nfcmrvl_nci_open(struct nci_dev *ndev)
0018 {
0019     struct nfcmrvl_private *priv = nci_get_drvdata(ndev);
0020     int err;
0021
0022     if (test_and_set_bit(NFCMRVL_NCI_RUNNING, &priv->flags))
0023         return 0;
0024
0025     /* Reset possible fault of previous session */
0026     clear_bit(NFCMRVL_PHY_ERROR, &priv->flags);
0027
0028     err = priv->if_ops->nci_open(priv);
0029
0030     if (err)
0031         clear_bit(NFCMRVL_NCI_RUNNING, &priv->flags);
0032
0033     return err;
0034 }
0035
0036 static int nfcmrvl_nci_close(struct nci_dev *ndev)
0037 {
0038     struct nfcmrvl_private *priv = nci_get_drvdata(ndev);
0039
0040     if (!test_and_clear_bit(NFCMRVL_NCI_RUNNING, &priv->flags))
0041         return 0;
0042
0043     priv->if_ops->nci_close(priv);
0044
0045     return 0;
0046 }
0047
0048 static int nfcmrvl_nci_send(struct nci_dev *ndev, struct sk_buff *skb)
0049 {
0050     struct nfcmrvl_private *priv = nci_get_drvdata(ndev);
0051
0052     nfc_info(priv->dev, "send entry, len %d\n", skb->len);
0053
0054     skb->dev = (void *)ndev;
0055
0056     if (priv->config.hci_muxed) {
0057         unsigned char *hdr;
0058         unsigned char len = skb->len;
0059
0060         hdr = skb_push(skb, NFCMRVL_HCI_EVENT_HEADER_SIZE);
0061         hdr[0] = NFCMRVL_HCI_COMMAND_CODE;
0062         hdr[1] = NFCMRVL_HCI_OGF;
0063         hdr[2] = NFCMRVL_HCI_OCF;
0064         hdr[3] = len;
0065     }
0066
0067     return priv->if_ops->nci_send(priv, skb);
0068 }
0069
0070 static int nfcmrvl_nci_setup(struct nci_dev *ndev)
0071 {
0072     __u8 val = 1;
0073
0074     nci_set_config(ndev, NFCMRVL_PB_BAIL_OUT, 1, &val);
0075     return 0;
0076 }
0077
0078 static int nfcmrvl_nci_fw_download(struct nci_dev *ndev,
0079                    const char *firmware_name)
0080 {
0081     return nfcmrvl_fw_dnld_start(ndev, firmware_name);
0082 }
0083
0084 static const struct nci_ops nfcmrvl_nci_ops = {
0085     .open = nfcmrvl_nci_open,
0086     .close = nfcmrvl_nci_close,
0087     .send = nfcmrvl_nci_send,
0088     .setup = nfcmrvl_nci_setup,
0089     .fw_download = nfcmrvl_nci_fw_download,
0090 };
0091
0092 struct nfcmrvl_private *nfcmrvl_nci_register_dev(enum nfcmrvl_phy phy,
0093                 void *drv_data,
0094                 const struct nfcmrvl_if_ops *ops,
0095                 struct device *dev,
0096                 const struct nfcmrvl_platform_data *pdata)
0097 {
0098     struct nfcmrvl_private *priv;
0099     int rc;
0100     int headroom;
0101     int tailroom;
0102     u32 protocols;
0103
0104     priv = kzalloc(sizeof(*priv), GFP_KERNEL);
0105     if (!priv)
0106         return ERR_PTR(-ENOMEM);
0107
0108     priv->drv_data = drv_data;
0109     priv->if_ops = ops;
0110     priv->dev = dev;
0111     priv->phy = phy;
0112
0113     memcpy(&priv->config, pdata, sizeof(*pdata));
0114
0115     if (gpio_is_valid(priv->config.reset_n_io)) {
0116         rc = gpio_request_one(priv->config.reset_n_io,
0117                       GPIOF_OUT_INIT_LOW,
0118                       "nfcmrvl_reset_n");
0119         if (rc < 0) {
0120             priv->config.reset_n_io = -EINVAL;
0121             nfc_err(dev, "failed to request reset_n io\n");
0122         }
0123     }
0124
0125     if (phy == NFCMRVL_PHY_SPI) {
0126         headroom = NCI_SPI_HDR_LEN;
0127         tailroom = 1;
0128     } else
0129         headroom = tailroom = 0;
0130
0131     if (priv->config.hci_muxed)
0132         headroom += NFCMRVL_HCI_EVENT_HEADER_SIZE;
0133
0134     protocols = NFC_PROTO_JEWEL_MASK
0135         | NFC_PROTO_MIFARE_MASK
0136         | NFC_PROTO_FELICA_MASK
0137         | NFC_PROTO_ISO14443_MASK
0138         | NFC_PROTO_ISO14443_B_MASK
0139         | NFC_PROTO_ISO15693_MASK
0140         | NFC_PROTO_NFC_DEP_MASK;
0141
0142     priv->ndev = nci_allocate_device(&nfcmrvl_nci_ops, protocols,
0143                      headroom, tailroom);
0144     if (!priv->ndev) {
0145         nfc_err(dev, "nci_allocate_device failed\n");
0146         rc = -ENOMEM;
0147         goto error_free_gpio;
0148     }
0149
0150     rc = nfcmrvl_fw_dnld_init(priv);
0151     if (rc) {
0152         nfc_err(dev, "failed to initialize FW download %d\n", rc);
0153         goto error_free_dev;
0154     }
0155
0156     nci_set_drvdata(priv->ndev, priv);
0157
0158     rc = nci_register_device(priv->ndev);
0159     if (rc) {
0160         nfc_err(dev, "nci_register_device failed %d\n", rc);
0161         goto error_fw_dnld_deinit;
0162     }
0163
0164     /* Ensure that controller is powered off */
0165     nfcmrvl_chip_halt(priv);
0166
0167     nfc_info(dev, "registered with nci successfully\n");
0168     return priv;
0169
0170 error_fw_dnld_deinit:
0171     nfcmrvl_fw_dnld_deinit(priv);
0172 error_free_dev:
0173     nci_free_device(priv->ndev);
0174 error_free_gpio:
0175     if (gpio_is_valid(priv->config.reset_n_io))
0176         gpio_free(priv->config.reset_n_io);
0177     kfree(priv);
0178     return ERR_PTR(rc);
0179 }
0180 EXPORT_SYMBOL_GPL(nfcmrvl_nci_register_dev);
0181
0182 void nfcmrvl_nci_unregister_dev(struct nfcmrvl_private *priv)
0183 {
0184     struct nci_dev *ndev = priv->ndev;
0185
0186     nci_unregister_device(ndev);
0187     if (priv->ndev->nfc_dev->fw_download_in_progress)
0188         nfcmrvl_fw_dnld_abort(priv);
0189
0190     nfcmrvl_fw_dnld_deinit(priv);
0191
0192     if (gpio_is_valid(priv->config.reset_n_io))
0193         gpio_free(priv->config.reset_n_io);
0194
0195     nci_free_device(ndev);
0196     kfree(priv);
0197 }
0198 EXPORT_SYMBOL_GPL(nfcmrvl_nci_unregister_dev);
0199
0200 int nfcmrvl_nci_recv_frame(struct nfcmrvl_private *priv, struct sk_buff *skb)
0201 {
0202     if (priv->config.hci_muxed) {
0203         if (skb->data[0] == NFCMRVL_HCI_EVENT_CODE &&
0204             skb->data[1] == NFCMRVL_HCI_NFC_EVENT_CODE) {
0205             /* Data packet, let's extract NCI payload */
0206             skb_pull(skb, NFCMRVL_HCI_EVENT_HEADER_SIZE);
0207         } else {
0208             /* Skip this packet */
0209             kfree_skb(skb);
0210             return 0;
0211         }
0212     }
0213
0214     if (priv->ndev->nfc_dev->fw_download_in_progress) {
0215         nfcmrvl_fw_dnld_recv_frame(priv, skb);
0216         return 0;
0217     }
0218
0219     if (test_bit(NFCMRVL_NCI_RUNNING, &priv->flags))
0220         nci_recv_frame(priv->ndev, skb);
0221     else {
0222         /* Drop this packet since nobody wants it */
0223         kfree_skb(skb);
0224         return 0;
0225     }
0226
0227     return 0;
0228 }
0229 EXPORT_SYMBOL_GPL(nfcmrvl_nci_recv_frame);
0230
0231 void nfcmrvl_chip_reset(struct nfcmrvl_private *priv)
0232 {
0233     /* Reset possible fault of previous session */
0234     clear_bit(NFCMRVL_PHY_ERROR, &priv->flags);
0235
0236     if (gpio_is_valid(priv->config.reset_n_io)) {
0237         nfc_info(priv->dev, "reset the chip\n");
0238         gpio_set_value(priv->config.reset_n_io, 0);
0239         usleep_range(5000, 10000);
0240         gpio_set_value(priv->config.reset_n_io, 1);
0241     } else
0242         nfc_info(priv->dev, "no reset available on this interface\n");
0243 }
0244
0245 void nfcmrvl_chip_halt(struct nfcmrvl_private *priv)
0246 {
0247     if (gpio_is_valid(priv->config.reset_n_io))
0248         gpio_set_value(priv->config.reset_n_io, 0);
0249 }
0250
0251 int nfcmrvl_parse_dt(struct device_node *node,
0252              struct nfcmrvl_platform_data *pdata)
0253 {
0254     int reset_n_io;
0255
0256     reset_n_io = of_get_named_gpio(node, "reset-n-io", 0);
0257     if (reset_n_io < 0) {
0258         pr_info("no reset-n-io config\n");
0259     } else if (!gpio_is_valid(reset_n_io)) {
0260         pr_err("invalid reset-n-io GPIO\n");
0261         return reset_n_io;
0262     }
0263     pdata->reset_n_io = reset_n_io;
0264
0265     if (of_find_property(node, "hci-muxed", NULL))
0266         pdata->hci_muxed = 1;
0267     else
0268         pdata->hci_muxed = 0;
0269
0270     return 0;
0271 }
0272 EXPORT_SYMBOL_GPL(nfcmrvl_parse_dt);
0273
0274 MODULE_AUTHOR("Marvell International Ltd.");
0275 MODULE_DESCRIPTION("Marvell NFC driver");
0276 MODULE_LICENSE("GPL v2");