LCOV - code coverage report
Current view: top level - drivers/usb/host - ohci-pci.c (source / functions) Hit Total Coverage
Test: combined.info Lines: 7 85 8.2 %
Date: 2022-03-28 15:32:58 Functions: 1 13 7.7 %
Branches: 1 22 4.5 %

           Branch data     Line data    Source code
       1                 :            : // SPDX-License-Identifier: GPL-1.0+
       2                 :            : /*
       3                 :            :  * OHCI HCD (Host Controller Driver) for USB.
       4                 :            :  *
       5                 :            :  * (C) Copyright 1999 Roman Weissgaerber <weissg@vienna.at>
       6                 :            :  * (C) Copyright 2000-2002 David Brownell <dbrownell@users.sourceforge.net>
       7                 :            :  *
       8                 :            :  * [ Initialisation is based on Linus'  ]
       9                 :            :  * [ uhci code and gregs ohci fragments ]
      10                 :            :  * [ (C) Copyright 1999 Linus Torvalds  ]
      11                 :            :  * [ (C) Copyright 1999 Gregory P. Smith]
      12                 :            :  *
      13                 :            :  * PCI Bus Glue
      14                 :            :  *
      15                 :            :  * This file is licenced under the GPL.
      16                 :            :  */
      17                 :            : 
      18                 :            : #include <linux/io.h>
      19                 :            : #include <linux/kernel.h>
      20                 :            : #include <linux/module.h>
      21                 :            : #include <linux/pci.h>
      22                 :            : #include <linux/usb.h>
      23                 :            : #include <linux/usb/hcd.h>
      24                 :            : 
      25                 :            : #include "ohci.h"
      26                 :            : #include "pci-quirks.h"
      27                 :            : 
      28                 :            : #define DRIVER_DESC "OHCI PCI platform driver"
      29                 :            : 
      30                 :            : static const char hcd_name[] = "ohci-pci";
      31                 :            : 
      32                 :            : 
      33                 :            : /*-------------------------------------------------------------------------*/
      34                 :            : 
      35                 :          0 : static int broken_suspend(struct usb_hcd *hcd)
      36                 :            : {
      37                 :          0 :         device_init_wakeup(&hcd->self.root_hub->dev, 0);
      38                 :          0 :         return 0;
      39                 :            : }
      40                 :            : 
      41                 :            : /* AMD 756, for most chips (early revs), corrupts register
      42                 :            :  * values on read ... so enable the vendor workaround.
      43                 :            :  */
      44                 :          0 : static int ohci_quirk_amd756(struct usb_hcd *hcd)
      45                 :            : {
      46                 :          0 :         struct ohci_hcd *ohci = hcd_to_ohci (hcd);
      47                 :            : 
      48                 :          0 :         ohci->flags = OHCI_QUIRK_AMD756;
      49                 :          0 :         ohci_dbg (ohci, "AMD756 erratum 4 workaround\n");
      50                 :            : 
      51                 :            :         /* also erratum 10 (suspend/resume issues) */
      52                 :          0 :         return broken_suspend(hcd);
      53                 :            : }
      54                 :            : 
      55                 :            : /* Apple's OHCI driver has a lot of bizarre workarounds
      56                 :            :  * for this chip.  Evidently control and bulk lists
      57                 :            :  * can get confused.  (B&W G3 models, and ...)
      58                 :            :  */
      59                 :          0 : static int ohci_quirk_opti(struct usb_hcd *hcd)
      60                 :            : {
      61                 :          0 :         struct ohci_hcd *ohci = hcd_to_ohci (hcd);
      62                 :            : 
      63                 :          0 :         ohci_dbg (ohci, "WARNING: OPTi workarounds unavailable\n");
      64                 :            : 
      65                 :          0 :         return 0;
      66                 :            : }
      67                 :            : 
      68                 :            : /* Check for NSC87560. We have to look at the bridge (fn1) to
      69                 :            :  * identify the USB (fn2). This quirk might apply to more or
      70                 :            :  * even all NSC stuff.
      71                 :            :  */
      72                 :          0 : static int ohci_quirk_ns(struct usb_hcd *hcd)
      73                 :            : {
      74                 :          0 :         struct pci_dev *pdev = to_pci_dev(hcd->self.controller);
      75                 :          0 :         struct pci_dev  *b;
      76                 :            : 
      77                 :          0 :         b  = pci_get_slot (pdev->bus, PCI_DEVFN (PCI_SLOT (pdev->devfn), 1));
      78         [ #  # ]:          0 :         if (b && b->device == PCI_DEVICE_ID_NS_87560_LIO
      79         [ #  # ]:          0 :             && b->vendor == PCI_VENDOR_ID_NS) {
      80                 :          0 :                 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
      81                 :            : 
      82                 :          0 :                 ohci->flags |= OHCI_QUIRK_SUPERIO;
      83                 :          0 :                 ohci_dbg (ohci, "Using NSC SuperIO setup\n");
      84                 :            :         }
      85                 :          0 :         pci_dev_put(b);
      86                 :            : 
      87                 :          0 :         return 0;
      88                 :            : }
      89                 :            : 
      90                 :            : /* Check for Compaq's ZFMicro chipset, which needs short
      91                 :            :  * delays before control or bulk queues get re-activated
      92                 :            :  * in finish_unlinks()
      93                 :            :  */
      94                 :          0 : static int ohci_quirk_zfmicro(struct usb_hcd *hcd)
      95                 :            : {
      96                 :          0 :         struct ohci_hcd *ohci = hcd_to_ohci (hcd);
      97                 :            : 
      98                 :          0 :         ohci->flags |= OHCI_QUIRK_ZFMICRO;
      99                 :          0 :         ohci_dbg(ohci, "enabled Compaq ZFMicro chipset quirks\n");
     100                 :            : 
     101                 :          0 :         return 0;
     102                 :            : }
     103                 :            : 
     104                 :            : /* Check for Toshiba SCC OHCI which has big endian registers
     105                 :            :  * and little endian in memory data structures
     106                 :            :  */
     107                 :          0 : static int ohci_quirk_toshiba_scc(struct usb_hcd *hcd)
     108                 :            : {
     109                 :          0 :         struct ohci_hcd *ohci = hcd_to_ohci (hcd);
     110                 :            : 
     111                 :            :         /* That chip is only present in the southbridge of some
     112                 :            :          * cell based platforms which are supposed to select
     113                 :            :          * CONFIG_USB_OHCI_BIG_ENDIAN_MMIO. We verify here if
     114                 :            :          * that was the case though.
     115                 :            :          */
     116                 :            : #ifdef CONFIG_USB_OHCI_BIG_ENDIAN_MMIO
     117                 :            :         ohci->flags |= OHCI_QUIRK_BE_MMIO;
     118                 :            :         ohci_dbg (ohci, "enabled big endian Toshiba quirk\n");
     119                 :            :         return 0;
     120                 :            : #else
     121                 :          0 :         ohci_err (ohci, "unsupported big endian Toshiba quirk\n");
     122                 :          0 :         return -ENXIO;
     123                 :            : #endif
     124                 :            : }
     125                 :            : 
     126                 :            : /* Check for NEC chip and apply quirk for allegedly lost interrupts.
     127                 :            :  */
     128                 :            : 
     129                 :          0 : static void ohci_quirk_nec_worker(struct work_struct *work)
     130                 :            : {
     131                 :          0 :         struct ohci_hcd *ohci = container_of(work, struct ohci_hcd, nec_work);
     132                 :          0 :         int status;
     133                 :            : 
     134                 :          0 :         status = ohci_restart(ohci);
     135         [ #  # ]:          0 :         if (status != 0)
     136                 :          0 :                 ohci_err(ohci, "Restarting NEC controller failed in %s, %d\n",
     137                 :            :                          "ohci_restart", status);
     138                 :          0 : }
     139                 :            : 
     140                 :          0 : static int ohci_quirk_nec(struct usb_hcd *hcd)
     141                 :            : {
     142                 :          0 :         struct ohci_hcd *ohci = hcd_to_ohci (hcd);
     143                 :            : 
     144                 :          0 :         ohci->flags |= OHCI_QUIRK_NEC;
     145                 :          0 :         INIT_WORK(&ohci->nec_work, ohci_quirk_nec_worker);
     146                 :          0 :         ohci_dbg (ohci, "enabled NEC chipset lost interrupt quirk\n");
     147                 :            : 
     148                 :          0 :         return 0;
     149                 :            : }
     150                 :            : 
     151                 :          0 : static int ohci_quirk_amd700(struct usb_hcd *hcd)
     152                 :            : {
     153                 :          0 :         struct ohci_hcd *ohci = hcd_to_ohci(hcd);
     154                 :            : 
     155         [ #  # ]:          0 :         if (usb_amd_quirk_pll_check())
     156                 :          0 :                 ohci->flags |= OHCI_QUIRK_AMD_PLL;
     157                 :            : 
     158                 :            :         /* SB800 needs pre-fetch fix */
     159         [ #  # ]:          0 :         if (usb_amd_prefetch_quirk()) {
     160                 :          0 :                 ohci->flags |= OHCI_QUIRK_AMD_PREFETCH;
     161                 :          0 :                 ohci_dbg(ohci, "enabled AMD prefetch quirk\n");
     162                 :            :         }
     163                 :            : 
     164                 :          0 :         ohci->flags |= OHCI_QUIRK_GLOBAL_SUSPEND;
     165                 :          0 :         return 0;
     166                 :            : }
     167                 :            : 
     168                 :          0 : static int ohci_quirk_qemu(struct usb_hcd *hcd)
     169                 :            : {
     170                 :          0 :         struct ohci_hcd *ohci = hcd_to_ohci(hcd);
     171                 :            : 
     172                 :          0 :         ohci->flags |= OHCI_QUIRK_QEMU;
     173                 :          0 :         ohci_dbg(ohci, "enabled qemu quirk\n");
     174                 :          0 :         return 0;
     175                 :            : }
     176                 :            : 
     177                 :            : /* List of quirks for OHCI */
     178                 :            : static const struct pci_device_id ohci_pci_quirks[] = {
     179                 :            :         {
     180                 :            :                 PCI_DEVICE(PCI_VENDOR_ID_AMD, 0x740c),
     181                 :            :                 .driver_data = (unsigned long)ohci_quirk_amd756,
     182                 :            :         },
     183                 :            :         {
     184                 :            :                 PCI_DEVICE(PCI_VENDOR_ID_OPTI, 0xc861),
     185                 :            :                 .driver_data = (unsigned long)ohci_quirk_opti,
     186                 :            :         },
     187                 :            :         {
     188                 :            :                 PCI_DEVICE(PCI_VENDOR_ID_NS, PCI_ANY_ID),
     189                 :            :                 .driver_data = (unsigned long)ohci_quirk_ns,
     190                 :            :         },
     191                 :            :         {
     192                 :            :                 PCI_DEVICE(PCI_VENDOR_ID_COMPAQ, 0xa0f8),
     193                 :            :                 .driver_data = (unsigned long)ohci_quirk_zfmicro,
     194                 :            :         },
     195                 :            :         {
     196                 :            :                 PCI_DEVICE(PCI_VENDOR_ID_TOSHIBA_2, 0x01b6),
     197                 :            :                 .driver_data = (unsigned long)ohci_quirk_toshiba_scc,
     198                 :            :         },
     199                 :            :         {
     200                 :            :                 PCI_DEVICE(PCI_VENDOR_ID_NEC, PCI_DEVICE_ID_NEC_USB),
     201                 :            :                 .driver_data = (unsigned long)ohci_quirk_nec,
     202                 :            :         },
     203                 :            :         {
     204                 :            :                 /* Toshiba portege 4000 */
     205                 :            :                 .vendor         = PCI_VENDOR_ID_AL,
     206                 :            :                 .device         = 0x5237,
     207                 :            :                 .subvendor      = PCI_VENDOR_ID_TOSHIBA,
     208                 :            :                 .subdevice      = 0x0004,
     209                 :            :                 .driver_data    = (unsigned long) broken_suspend,
     210                 :            :         },
     211                 :            :         {
     212                 :            :                 PCI_DEVICE(PCI_VENDOR_ID_ITE, 0x8152),
     213                 :            :                 .driver_data = (unsigned long) broken_suspend,
     214                 :            :         },
     215                 :            :         {
     216                 :            :                 PCI_DEVICE(PCI_VENDOR_ID_ATI, 0x4397),
     217                 :            :                 .driver_data = (unsigned long)ohci_quirk_amd700,
     218                 :            :         },
     219                 :            :         {
     220                 :            :                 PCI_DEVICE(PCI_VENDOR_ID_ATI, 0x4398),
     221                 :            :                 .driver_data = (unsigned long)ohci_quirk_amd700,
     222                 :            :         },
     223                 :            :         {
     224                 :            :                 PCI_DEVICE(PCI_VENDOR_ID_ATI, 0x4399),
     225                 :            :                 .driver_data = (unsigned long)ohci_quirk_amd700,
     226                 :            :         },
     227                 :            :         {
     228                 :            :                 .vendor         = PCI_VENDOR_ID_APPLE,
     229                 :            :                 .device         = 0x003f,
     230                 :            :                 .subvendor      = PCI_SUBVENDOR_ID_REDHAT_QUMRANET,
     231                 :            :                 .subdevice      = PCI_SUBDEVICE_ID_QEMU,
     232                 :            :                 .driver_data    = (unsigned long)ohci_quirk_qemu,
     233                 :            :         },
     234                 :            : 
     235                 :            :         /* FIXME for some of the early AMD 760 southbridges, OHCI
     236                 :            :          * won't work at all.  blacklist them.
     237                 :            :          */
     238                 :            : 
     239                 :            :         {},
     240                 :            : };
     241                 :            : 
     242                 :          0 : static int ohci_pci_reset (struct usb_hcd *hcd)
     243                 :            : {
     244         [ #  # ]:          0 :         struct ohci_hcd *ohci = hcd_to_ohci (hcd);
     245                 :          0 :         struct pci_dev *pdev = to_pci_dev(hcd->self.controller);
     246                 :          0 :         int ret = 0;
     247                 :            : 
     248         [ #  # ]:          0 :         if (hcd->self.controller) {
     249                 :          0 :                 const struct pci_device_id *quirk_id;
     250                 :            : 
     251                 :          0 :                 quirk_id = pci_match_id(ohci_pci_quirks, pdev);
     252         [ #  # ]:          0 :                 if (quirk_id != NULL) {
     253                 :          0 :                         int (*quirk)(struct usb_hcd *ohci);
     254                 :          0 :                         quirk = (void *)quirk_id->driver_data;
     255                 :          0 :                         ret = quirk(hcd);
     256                 :            :                 }
     257                 :            :         }
     258                 :            : 
     259         [ #  # ]:          0 :         if (ret == 0)
     260                 :          0 :                 ret = ohci_setup(hcd);
     261                 :            :         /*
     262                 :            :         * After ohci setup RWC may not be set for add-in PCI cards.
     263                 :            :         * This transfers PCI PM wakeup capabilities.
     264                 :            :         */
     265         [ #  # ]:          0 :         if (device_can_wakeup(&pdev->dev))
     266                 :          0 :                 ohci->hc_control |= OHCI_CTRL_RWC;
     267                 :          0 :         return ret;
     268                 :            : }
     269                 :            : 
     270                 :            : static struct hc_driver __read_mostly ohci_pci_hc_driver;
     271                 :            : 
     272                 :            : static const struct ohci_driver_overrides pci_overrides __initconst = {
     273                 :            :         .product_desc =         "OHCI PCI host controller",
     274                 :            :         .reset =                ohci_pci_reset,
     275                 :            : };
     276                 :            : 
     277                 :            : static const struct pci_device_id pci_ids[] = { {
     278                 :            :         /* handle any USB OHCI controller */
     279                 :            :         PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_OHCI, ~0),
     280                 :            :         .driver_data =  (unsigned long) &ohci_pci_hc_driver,
     281                 :            :         }, {
     282                 :            :         /* The device in the ConneXT I/O hub has no class reg */
     283                 :            :         PCI_VDEVICE(STMICRO, PCI_DEVICE_ID_STMICRO_USB_OHCI),
     284                 :            :         .driver_data =  (unsigned long) &ohci_pci_hc_driver,
     285                 :            :         }, { /* end: all zeroes */ }
     286                 :            : };
     287                 :            : MODULE_DEVICE_TABLE (pci, pci_ids);
     288                 :            : 
     289                 :            : /* pci driver glue; this is a "new style" PCI driver module */
     290                 :            : static struct pci_driver ohci_pci_driver = {
     291                 :            :         .name =         (char *) hcd_name,
     292                 :            :         .id_table =     pci_ids,
     293                 :            : 
     294                 :            :         .probe =        usb_hcd_pci_probe,
     295                 :            :         .remove =       usb_hcd_pci_remove,
     296                 :            :         .shutdown =     usb_hcd_pci_shutdown,
     297                 :            : 
     298                 :            : #ifdef CONFIG_PM
     299                 :            :         .driver =       {
     300                 :            :                 .pm =   &usb_hcd_pci_pm_ops
     301                 :            :         },
     302                 :            : #endif
     303                 :            : };
     304                 :            : 
     305                 :         28 : static int __init ohci_pci_init(void)
     306                 :            : {
     307         [ +  - ]:         28 :         if (usb_disabled())
     308                 :            :                 return -ENODEV;
     309                 :            : 
     310                 :         28 :         pr_info("%s: " DRIVER_DESC "\n", hcd_name);
     311                 :            : 
     312                 :         28 :         ohci_init_driver(&ohci_pci_hc_driver, &pci_overrides);
     313                 :            : 
     314                 :            : #ifdef  CONFIG_PM
     315                 :            :         /* Entries for the PCI suspend/resume callbacks are special */
     316                 :         28 :         ohci_pci_hc_driver.pci_suspend = ohci_suspend;
     317                 :         28 :         ohci_pci_hc_driver.pci_resume = ohci_resume;
     318                 :            : #endif
     319                 :            : 
     320                 :         28 :         return pci_register_driver(&ohci_pci_driver);
     321                 :            : }
     322                 :            : module_init(ohci_pci_init);
     323                 :            : 
     324                 :          0 : static void __exit ohci_pci_cleanup(void)
     325                 :            : {
     326                 :          0 :         pci_unregister_driver(&ohci_pci_driver);
     327                 :          0 : }
     328                 :            : module_exit(ohci_pci_cleanup);
     329                 :            : 
     330                 :            : MODULE_DESCRIPTION(DRIVER_DESC);
     331                 :            : MODULE_LICENSE("GPL");
     332                 :            : MODULE_SOFTDEP("pre: ehci_pci");

Generated by: LCOV version 1.14