109c434b8SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-only 216603153SAndreas Noever /* 315c6784cSMika Westerberg * Thunderbolt driver - NHI driver 416603153SAndreas Noever * 516603153SAndreas Noever * The NHI (native host interface) is the pci device that allows us to send and 616603153SAndreas Noever * receive frames from the thunderbolt bus. 716603153SAndreas Noever * 816603153SAndreas Noever * Copyright (c) 2014 Andreas Noever <andreas.noever@gmail.com> 915c6784cSMika Westerberg * Copyright (C) 2018, Intel Corporation 1016603153SAndreas Noever */ 1116603153SAndreas Noever 1223dd5bb4SAndreas Noever #include <linux/pm_runtime.h> 1316603153SAndreas Noever #include <linux/slab.h> 1416603153SAndreas Noever #include <linux/errno.h> 1516603153SAndreas Noever #include <linux/pci.h> 1697486e98SChristophe JAILLET #include <linux/dma-mapping.h> 1716603153SAndreas Noever #include <linux/interrupt.h> 1886eaf4a5SRobin Murphy #include <linux/iommu.h> 1916603153SAndreas Noever #include <linux/module.h> 20cd446ee2SMika Westerberg #include <linux/delay.h> 213cdb9446SMika Westerberg #include <linux/property.h> 2286eaf4a5SRobin Murphy #include <linux/string_helpers.h> 2316603153SAndreas Noever 2416603153SAndreas Noever #include "nhi.h" 2516603153SAndreas Noever #include "nhi_regs.h" 26d6cc51cdSAndreas Noever #include "tb.h" 2716603153SAndreas Noever 2816603153SAndreas Noever #define RING_TYPE(ring) ((ring)->is_tx ? "TX ring" : "RX ring") 2916603153SAndreas Noever 3053f13319SMika Westerberg #define RING_FIRST_USABLE_HOPID 1 319fb1e654SMika Westerberg 329fb1e654SMika Westerberg /* 33046bee1fSMika Westerberg * Minimal number of vectors when we use MSI-X. Two for control channel 34046bee1fSMika Westerberg * Rx/Tx and the rest four are for cross domain DMA paths. 35046bee1fSMika Westerberg */ 36046bee1fSMika Westerberg #define MSIX_MIN_VECS 6 37046bee1fSMika Westerberg #define MSIX_MAX_VECS 16 3816603153SAndreas Noever 39cd446ee2SMika Westerberg #define NHI_MAILBOX_TIMEOUT 500 /* ms */ 40cd446ee2SMika Westerberg 41e390909aSSanjay R Mehta #define QUIRK_AUTO_CLEAR_INT BIT(0) 42e390909aSSanjay R Mehta 4316603153SAndreas Noever static int ring_interrupt_index(struct tb_ring *ring) 4416603153SAndreas Noever { 4516603153SAndreas Noever int bit = ring->hop; 4616603153SAndreas Noever if (!ring->is_tx) 4716603153SAndreas Noever bit += ring->nhi->hop_count; 4816603153SAndreas Noever return bit; 4916603153SAndreas Noever } 5016603153SAndreas Noever 51a7bfb27bSLee Jones /* 5216603153SAndreas Noever * ring_interrupt_active() - activate/deactivate interrupts for a single ring 5316603153SAndreas Noever * 5416603153SAndreas Noever * ring->nhi->lock must be held. 5516603153SAndreas Noever */ 5616603153SAndreas Noever static void ring_interrupt_active(struct tb_ring *ring, bool active) 5716603153SAndreas Noever { 5819bf4d4fSLukas Wunner int reg = REG_RING_INTERRUPT_BASE + 5919bf4d4fSLukas Wunner ring_interrupt_index(ring) / 32 * 4; 6016603153SAndreas Noever int bit = ring_interrupt_index(ring) & 31; 6116603153SAndreas Noever int mask = 1 << bit; 6216603153SAndreas Noever u32 old, new; 63046bee1fSMika Westerberg 64046bee1fSMika Westerberg if (ring->irq > 0) { 65046bee1fSMika Westerberg u32 step, shift, ivr, misc; 66046bee1fSMika Westerberg void __iomem *ivr_base; 67046bee1fSMika Westerberg int index; 68046bee1fSMika Westerberg 69046bee1fSMika Westerberg if (ring->is_tx) 70046bee1fSMika Westerberg index = ring->hop; 71046bee1fSMika Westerberg else 72046bee1fSMika Westerberg index = ring->hop + ring->nhi->hop_count; 73046bee1fSMika Westerberg 74e390909aSSanjay R Mehta if (ring->nhi->quirks & QUIRK_AUTO_CLEAR_INT) { 75046bee1fSMika Westerberg /* 76e390909aSSanjay R Mehta * Ask the hardware to clear interrupt status 77e390909aSSanjay R Mehta * bits automatically since we already know 78e390909aSSanjay R Mehta * which interrupt was triggered. 79046bee1fSMika Westerberg */ 80046bee1fSMika Westerberg misc = ioread32(ring->nhi->iobase + REG_DMA_MISC); 81046bee1fSMika Westerberg if (!(misc & REG_DMA_MISC_INT_AUTO_CLEAR)) { 82046bee1fSMika Westerberg misc |= REG_DMA_MISC_INT_AUTO_CLEAR; 83046bee1fSMika Westerberg iowrite32(misc, ring->nhi->iobase + REG_DMA_MISC); 84046bee1fSMika Westerberg } 85e390909aSSanjay R Mehta } 86046bee1fSMika Westerberg 87046bee1fSMika Westerberg ivr_base = ring->nhi->iobase + REG_INT_VEC_ALLOC_BASE; 88046bee1fSMika Westerberg step = index / REG_INT_VEC_ALLOC_REGS * REG_INT_VEC_ALLOC_BITS; 89046bee1fSMika Westerberg shift = index % REG_INT_VEC_ALLOC_REGS * REG_INT_VEC_ALLOC_BITS; 90046bee1fSMika Westerberg ivr = ioread32(ivr_base + step); 91046bee1fSMika Westerberg ivr &= ~(REG_INT_VEC_ALLOC_MASK << shift); 92046bee1fSMika Westerberg if (active) 93046bee1fSMika Westerberg ivr |= ring->vector << shift; 94046bee1fSMika Westerberg iowrite32(ivr, ivr_base + step); 95046bee1fSMika Westerberg } 96046bee1fSMika Westerberg 9716603153SAndreas Noever old = ioread32(ring->nhi->iobase + reg); 9816603153SAndreas Noever if (active) 9916603153SAndreas Noever new = old | mask; 10016603153SAndreas Noever else 10116603153SAndreas Noever new = old & ~mask; 10216603153SAndreas Noever 103daa5140fSMika Westerberg dev_dbg(&ring->nhi->pdev->dev, 10416603153SAndreas Noever "%s interrupt at register %#x bit %d (%#x -> %#x)\n", 10516603153SAndreas Noever active ? "enabling" : "disabling", reg, bit, old, new); 10616603153SAndreas Noever 10716603153SAndreas Noever if (new == old) 10816603153SAndreas Noever dev_WARN(&ring->nhi->pdev->dev, 10916603153SAndreas Noever "interrupt for %s %d is already %s\n", 11016603153SAndreas Noever RING_TYPE(ring), ring->hop, 11116603153SAndreas Noever active ? "enabled" : "disabled"); 11216603153SAndreas Noever iowrite32(new, ring->nhi->iobase + reg); 11316603153SAndreas Noever } 11416603153SAndreas Noever 115a7bfb27bSLee Jones /* 11616603153SAndreas Noever * nhi_disable_interrupts() - disable interrupts for all rings 11716603153SAndreas Noever * 11816603153SAndreas Noever * Use only during init and shutdown. 11916603153SAndreas Noever */ 12016603153SAndreas Noever static void nhi_disable_interrupts(struct tb_nhi *nhi) 12116603153SAndreas Noever { 12216603153SAndreas Noever int i = 0; 12316603153SAndreas Noever /* disable interrupts */ 12416603153SAndreas Noever for (i = 0; i < RING_INTERRUPT_REG_COUNT(nhi); i++) 12516603153SAndreas Noever iowrite32(0, nhi->iobase + REG_RING_INTERRUPT_BASE + 4 * i); 12616603153SAndreas Noever 12716603153SAndreas Noever /* clear interrupt status bits */ 12816603153SAndreas Noever for (i = 0; i < RING_NOTIFY_REG_COUNT(nhi); i++) 12916603153SAndreas Noever ioread32(nhi->iobase + REG_RING_NOTIFY_BASE + 4 * i); 13016603153SAndreas Noever } 13116603153SAndreas Noever 13216603153SAndreas Noever /* ring helper methods */ 13316603153SAndreas Noever 13416603153SAndreas Noever static void __iomem *ring_desc_base(struct tb_ring *ring) 13516603153SAndreas Noever { 13616603153SAndreas Noever void __iomem *io = ring->nhi->iobase; 13716603153SAndreas Noever io += ring->is_tx ? REG_TX_RING_BASE : REG_RX_RING_BASE; 13816603153SAndreas Noever io += ring->hop * 16; 13916603153SAndreas Noever return io; 14016603153SAndreas Noever } 14116603153SAndreas Noever 14216603153SAndreas Noever static void __iomem *ring_options_base(struct tb_ring *ring) 14316603153SAndreas Noever { 14416603153SAndreas Noever void __iomem *io = ring->nhi->iobase; 14516603153SAndreas Noever io += ring->is_tx ? REG_TX_OPTIONS_BASE : REG_RX_OPTIONS_BASE; 14616603153SAndreas Noever io += ring->hop * 32; 14716603153SAndreas Noever return io; 14816603153SAndreas Noever } 14916603153SAndreas Noever 15094379521SMika Westerberg static void ring_iowrite_cons(struct tb_ring *ring, u16 cons) 15116603153SAndreas Noever { 15294379521SMika Westerberg /* 15394379521SMika Westerberg * The other 16-bits in the register is read-only and writes to it 15494379521SMika Westerberg * are ignored by the hardware so we can save one ioread32() by 15594379521SMika Westerberg * filling the read-only bits with zeroes. 15694379521SMika Westerberg */ 15794379521SMika Westerberg iowrite32(cons, ring_desc_base(ring) + 8); 15894379521SMika Westerberg } 15994379521SMika Westerberg 16094379521SMika Westerberg static void ring_iowrite_prod(struct tb_ring *ring, u16 prod) 16194379521SMika Westerberg { 16294379521SMika Westerberg /* See ring_iowrite_cons() above for explanation */ 16394379521SMika Westerberg iowrite32(prod << 16, ring_desc_base(ring) + 8); 16416603153SAndreas Noever } 16516603153SAndreas Noever 16616603153SAndreas Noever static void ring_iowrite32desc(struct tb_ring *ring, u32 value, u32 offset) 16716603153SAndreas Noever { 16816603153SAndreas Noever iowrite32(value, ring_desc_base(ring) + offset); 16916603153SAndreas Noever } 17016603153SAndreas Noever 17116603153SAndreas Noever static void ring_iowrite64desc(struct tb_ring *ring, u64 value, u32 offset) 17216603153SAndreas Noever { 17316603153SAndreas Noever iowrite32(value, ring_desc_base(ring) + offset); 17416603153SAndreas Noever iowrite32(value >> 32, ring_desc_base(ring) + offset + 4); 17516603153SAndreas Noever } 17616603153SAndreas Noever 17716603153SAndreas Noever static void ring_iowrite32options(struct tb_ring *ring, u32 value, u32 offset) 17816603153SAndreas Noever { 17916603153SAndreas Noever iowrite32(value, ring_options_base(ring) + offset); 18016603153SAndreas Noever } 18116603153SAndreas Noever 18216603153SAndreas Noever static bool ring_full(struct tb_ring *ring) 18316603153SAndreas Noever { 18416603153SAndreas Noever return ((ring->head + 1) % ring->size) == ring->tail; 18516603153SAndreas Noever } 18616603153SAndreas Noever 18716603153SAndreas Noever static bool ring_empty(struct tb_ring *ring) 18816603153SAndreas Noever { 18916603153SAndreas Noever return ring->head == ring->tail; 19016603153SAndreas Noever } 19116603153SAndreas Noever 192a7bfb27bSLee Jones /* 19316603153SAndreas Noever * ring_write_descriptors() - post frames from ring->queue to the controller 19416603153SAndreas Noever * 19516603153SAndreas Noever * ring->lock is held. 19616603153SAndreas Noever */ 19716603153SAndreas Noever static void ring_write_descriptors(struct tb_ring *ring) 19816603153SAndreas Noever { 19916603153SAndreas Noever struct ring_frame *frame, *n; 20016603153SAndreas Noever struct ring_desc *descriptor; 20116603153SAndreas Noever list_for_each_entry_safe(frame, n, &ring->queue, list) { 20216603153SAndreas Noever if (ring_full(ring)) 20316603153SAndreas Noever break; 20416603153SAndreas Noever list_move_tail(&frame->list, &ring->in_flight); 20516603153SAndreas Noever descriptor = &ring->descriptors[ring->head]; 20616603153SAndreas Noever descriptor->phys = frame->buffer_phy; 20716603153SAndreas Noever descriptor->time = 0; 20816603153SAndreas Noever descriptor->flags = RING_DESC_POSTED | RING_DESC_INTERRUPT; 20916603153SAndreas Noever if (ring->is_tx) { 21016603153SAndreas Noever descriptor->length = frame->size; 21116603153SAndreas Noever descriptor->eof = frame->eof; 21216603153SAndreas Noever descriptor->sof = frame->sof; 21316603153SAndreas Noever } 21416603153SAndreas Noever ring->head = (ring->head + 1) % ring->size; 21594379521SMika Westerberg if (ring->is_tx) 21694379521SMika Westerberg ring_iowrite_prod(ring, ring->head); 21794379521SMika Westerberg else 21894379521SMika Westerberg ring_iowrite_cons(ring, ring->head); 21916603153SAndreas Noever } 22016603153SAndreas Noever } 22116603153SAndreas Noever 222a7bfb27bSLee Jones /* 22316603153SAndreas Noever * ring_work() - progress completed frames 22416603153SAndreas Noever * 22516603153SAndreas Noever * If the ring is shutting down then all frames are marked as canceled and 22616603153SAndreas Noever * their callbacks are invoked. 22716603153SAndreas Noever * 22816603153SAndreas Noever * Otherwise we collect all completed frame from the ring buffer, write new 22916603153SAndreas Noever * frame to the ring buffer and invoke the callbacks for the completed frames. 23016603153SAndreas Noever */ 23116603153SAndreas Noever static void ring_work(struct work_struct *work) 23216603153SAndreas Noever { 23316603153SAndreas Noever struct tb_ring *ring = container_of(work, typeof(*ring), work); 23416603153SAndreas Noever struct ring_frame *frame; 23516603153SAndreas Noever bool canceled = false; 23622b7de10SMika Westerberg unsigned long flags; 23716603153SAndreas Noever LIST_HEAD(done); 23822b7de10SMika Westerberg 23922b7de10SMika Westerberg spin_lock_irqsave(&ring->lock, flags); 24016603153SAndreas Noever 24116603153SAndreas Noever if (!ring->running) { 24216603153SAndreas Noever /* Move all frames to done and mark them as canceled. */ 24316603153SAndreas Noever list_splice_tail_init(&ring->in_flight, &done); 24416603153SAndreas Noever list_splice_tail_init(&ring->queue, &done); 24516603153SAndreas Noever canceled = true; 24616603153SAndreas Noever goto invoke_callback; 24716603153SAndreas Noever } 24816603153SAndreas Noever 24916603153SAndreas Noever while (!ring_empty(ring)) { 25016603153SAndreas Noever if (!(ring->descriptors[ring->tail].flags 25116603153SAndreas Noever & RING_DESC_COMPLETED)) 25216603153SAndreas Noever break; 25316603153SAndreas Noever frame = list_first_entry(&ring->in_flight, typeof(*frame), 25416603153SAndreas Noever list); 25516603153SAndreas Noever list_move_tail(&frame->list, &done); 25616603153SAndreas Noever if (!ring->is_tx) { 25716603153SAndreas Noever frame->size = ring->descriptors[ring->tail].length; 25816603153SAndreas Noever frame->eof = ring->descriptors[ring->tail].eof; 25916603153SAndreas Noever frame->sof = ring->descriptors[ring->tail].sof; 26016603153SAndreas Noever frame->flags = ring->descriptors[ring->tail].flags; 26116603153SAndreas Noever } 26216603153SAndreas Noever ring->tail = (ring->tail + 1) % ring->size; 26316603153SAndreas Noever } 26416603153SAndreas Noever ring_write_descriptors(ring); 26516603153SAndreas Noever 26616603153SAndreas Noever invoke_callback: 26722b7de10SMika Westerberg /* allow callbacks to schedule new work */ 26822b7de10SMika Westerberg spin_unlock_irqrestore(&ring->lock, flags); 26916603153SAndreas Noever while (!list_empty(&done)) { 27016603153SAndreas Noever frame = list_first_entry(&done, typeof(*frame), list); 27116603153SAndreas Noever /* 27216603153SAndreas Noever * The callback may reenqueue or delete frame. 27316603153SAndreas Noever * Do not hold on to it. 27416603153SAndreas Noever */ 27516603153SAndreas Noever list_del_init(&frame->list); 2764ffe722eSMika Westerberg if (frame->callback) 27716603153SAndreas Noever frame->callback(ring, frame, canceled); 27816603153SAndreas Noever } 27916603153SAndreas Noever } 28016603153SAndreas Noever 2813b3d9f4dSMika Westerberg int __tb_ring_enqueue(struct tb_ring *ring, struct ring_frame *frame) 28216603153SAndreas Noever { 28322b7de10SMika Westerberg unsigned long flags; 28416603153SAndreas Noever int ret = 0; 28522b7de10SMika Westerberg 28622b7de10SMika Westerberg spin_lock_irqsave(&ring->lock, flags); 28716603153SAndreas Noever if (ring->running) { 28816603153SAndreas Noever list_add_tail(&frame->list, &ring->queue); 28916603153SAndreas Noever ring_write_descriptors(ring); 29016603153SAndreas Noever } else { 29116603153SAndreas Noever ret = -ESHUTDOWN; 29216603153SAndreas Noever } 29322b7de10SMika Westerberg spin_unlock_irqrestore(&ring->lock, flags); 29416603153SAndreas Noever return ret; 29516603153SAndreas Noever } 2963b3d9f4dSMika Westerberg EXPORT_SYMBOL_GPL(__tb_ring_enqueue); 29716603153SAndreas Noever 2984ffe722eSMika Westerberg /** 2994ffe722eSMika Westerberg * tb_ring_poll() - Poll one completed frame from the ring 3004ffe722eSMika Westerberg * @ring: Ring to poll 3014ffe722eSMika Westerberg * 3024ffe722eSMika Westerberg * This function can be called when @start_poll callback of the @ring 3034ffe722eSMika Westerberg * has been called. It will read one completed frame from the ring and 3044ffe722eSMika Westerberg * return it to the caller. Returns %NULL if there is no more completed 3054ffe722eSMika Westerberg * frames. 3064ffe722eSMika Westerberg */ 3074ffe722eSMika Westerberg struct ring_frame *tb_ring_poll(struct tb_ring *ring) 3084ffe722eSMika Westerberg { 3094ffe722eSMika Westerberg struct ring_frame *frame = NULL; 3104ffe722eSMika Westerberg unsigned long flags; 3114ffe722eSMika Westerberg 3124ffe722eSMika Westerberg spin_lock_irqsave(&ring->lock, flags); 3134ffe722eSMika Westerberg if (!ring->running) 3144ffe722eSMika Westerberg goto unlock; 3154ffe722eSMika Westerberg if (ring_empty(ring)) 3164ffe722eSMika Westerberg goto unlock; 3174ffe722eSMika Westerberg 3184ffe722eSMika Westerberg if (ring->descriptors[ring->tail].flags & RING_DESC_COMPLETED) { 3194ffe722eSMika Westerberg frame = list_first_entry(&ring->in_flight, typeof(*frame), 3204ffe722eSMika Westerberg list); 3214ffe722eSMika Westerberg list_del_init(&frame->list); 3224ffe722eSMika Westerberg 3234ffe722eSMika Westerberg if (!ring->is_tx) { 3244ffe722eSMika Westerberg frame->size = ring->descriptors[ring->tail].length; 3254ffe722eSMika Westerberg frame->eof = ring->descriptors[ring->tail].eof; 3264ffe722eSMika Westerberg frame->sof = ring->descriptors[ring->tail].sof; 3274ffe722eSMika Westerberg frame->flags = ring->descriptors[ring->tail].flags; 3284ffe722eSMika Westerberg } 3294ffe722eSMika Westerberg 3304ffe722eSMika Westerberg ring->tail = (ring->tail + 1) % ring->size; 3314ffe722eSMika Westerberg } 3324ffe722eSMika Westerberg 3334ffe722eSMika Westerberg unlock: 3344ffe722eSMika Westerberg spin_unlock_irqrestore(&ring->lock, flags); 3354ffe722eSMika Westerberg return frame; 3364ffe722eSMika Westerberg } 3374ffe722eSMika Westerberg EXPORT_SYMBOL_GPL(tb_ring_poll); 3384ffe722eSMika Westerberg 3394ffe722eSMika Westerberg static void __ring_interrupt_mask(struct tb_ring *ring, bool mask) 3404ffe722eSMika Westerberg { 3414ffe722eSMika Westerberg int idx = ring_interrupt_index(ring); 3424ffe722eSMika Westerberg int reg = REG_RING_INTERRUPT_BASE + idx / 32 * 4; 3434ffe722eSMika Westerberg int bit = idx % 32; 3444ffe722eSMika Westerberg u32 val; 3454ffe722eSMika Westerberg 3464ffe722eSMika Westerberg val = ioread32(ring->nhi->iobase + reg); 3474ffe722eSMika Westerberg if (mask) 3484ffe722eSMika Westerberg val &= ~BIT(bit); 3494ffe722eSMika Westerberg else 3504ffe722eSMika Westerberg val |= BIT(bit); 3514ffe722eSMika Westerberg iowrite32(val, ring->nhi->iobase + reg); 3524ffe722eSMika Westerberg } 3534ffe722eSMika Westerberg 3544ffe722eSMika Westerberg /* Both @nhi->lock and @ring->lock should be held */ 3554ffe722eSMika Westerberg static void __ring_interrupt(struct tb_ring *ring) 3564ffe722eSMika Westerberg { 3574ffe722eSMika Westerberg if (!ring->running) 3584ffe722eSMika Westerberg return; 3594ffe722eSMika Westerberg 3604ffe722eSMika Westerberg if (ring->start_poll) { 36174657181SMika Westerberg __ring_interrupt_mask(ring, true); 3624ffe722eSMika Westerberg ring->start_poll(ring->poll_data); 3634ffe722eSMika Westerberg } else { 3644ffe722eSMika Westerberg schedule_work(&ring->work); 3654ffe722eSMika Westerberg } 3664ffe722eSMika Westerberg } 3674ffe722eSMika Westerberg 3684ffe722eSMika Westerberg /** 3694ffe722eSMika Westerberg * tb_ring_poll_complete() - Re-start interrupt for the ring 3704ffe722eSMika Westerberg * @ring: Ring to re-start the interrupt 3714ffe722eSMika Westerberg * 3724ffe722eSMika Westerberg * This will re-start (unmask) the ring interrupt once the user is done 3734ffe722eSMika Westerberg * with polling. 3744ffe722eSMika Westerberg */ 3754ffe722eSMika Westerberg void tb_ring_poll_complete(struct tb_ring *ring) 3764ffe722eSMika Westerberg { 3774ffe722eSMika Westerberg unsigned long flags; 3784ffe722eSMika Westerberg 3794ffe722eSMika Westerberg spin_lock_irqsave(&ring->nhi->lock, flags); 3804ffe722eSMika Westerberg spin_lock(&ring->lock); 3814ffe722eSMika Westerberg if (ring->start_poll) 3824ffe722eSMika Westerberg __ring_interrupt_mask(ring, false); 3834ffe722eSMika Westerberg spin_unlock(&ring->lock); 3844ffe722eSMika Westerberg spin_unlock_irqrestore(&ring->nhi->lock, flags); 3854ffe722eSMika Westerberg } 3864ffe722eSMika Westerberg EXPORT_SYMBOL_GPL(tb_ring_poll_complete); 3874ffe722eSMika Westerberg 3887a1808f8SSanjay R Mehta static void ring_clear_msix(const struct tb_ring *ring) 3897a1808f8SSanjay R Mehta { 3907a1808f8SSanjay R Mehta if (ring->nhi->quirks & QUIRK_AUTO_CLEAR_INT) 3917a1808f8SSanjay R Mehta return; 3927a1808f8SSanjay R Mehta 3937a1808f8SSanjay R Mehta if (ring->is_tx) 3947a1808f8SSanjay R Mehta ioread32(ring->nhi->iobase + REG_RING_NOTIFY_BASE); 3957a1808f8SSanjay R Mehta else 3967a1808f8SSanjay R Mehta ioread32(ring->nhi->iobase + REG_RING_NOTIFY_BASE + 3977a1808f8SSanjay R Mehta 4 * (ring->nhi->hop_count / 32)); 3987a1808f8SSanjay R Mehta } 3997a1808f8SSanjay R Mehta 400046bee1fSMika Westerberg static irqreturn_t ring_msix(int irq, void *data) 401046bee1fSMika Westerberg { 402046bee1fSMika Westerberg struct tb_ring *ring = data; 403046bee1fSMika Westerberg 4044ffe722eSMika Westerberg spin_lock(&ring->nhi->lock); 4057a1808f8SSanjay R Mehta ring_clear_msix(ring); 4064ffe722eSMika Westerberg spin_lock(&ring->lock); 4074ffe722eSMika Westerberg __ring_interrupt(ring); 4084ffe722eSMika Westerberg spin_unlock(&ring->lock); 4094ffe722eSMika Westerberg spin_unlock(&ring->nhi->lock); 4104ffe722eSMika Westerberg 411046bee1fSMika Westerberg return IRQ_HANDLED; 412046bee1fSMika Westerberg } 413046bee1fSMika Westerberg 414046bee1fSMika Westerberg static int ring_request_msix(struct tb_ring *ring, bool no_suspend) 415046bee1fSMika Westerberg { 416046bee1fSMika Westerberg struct tb_nhi *nhi = ring->nhi; 417046bee1fSMika Westerberg unsigned long irqflags; 418046bee1fSMika Westerberg int ret; 419046bee1fSMika Westerberg 420046bee1fSMika Westerberg if (!nhi->pdev->msix_enabled) 421046bee1fSMika Westerberg return 0; 422046bee1fSMika Westerberg 423046bee1fSMika Westerberg ret = ida_simple_get(&nhi->msix_ida, 0, MSIX_MAX_VECS, GFP_KERNEL); 424046bee1fSMika Westerberg if (ret < 0) 425046bee1fSMika Westerberg return ret; 426046bee1fSMika Westerberg 427046bee1fSMika Westerberg ring->vector = ret; 428046bee1fSMika Westerberg 4297342ca34SJing Xiangfeng ret = pci_irq_vector(ring->nhi->pdev, ring->vector); 4307342ca34SJing Xiangfeng if (ret < 0) 4317342ca34SJing Xiangfeng goto err_ida_remove; 4327342ca34SJing Xiangfeng 4337342ca34SJing Xiangfeng ring->irq = ret; 434046bee1fSMika Westerberg 435046bee1fSMika Westerberg irqflags = no_suspend ? IRQF_NO_SUSPEND : 0; 4367342ca34SJing Xiangfeng ret = request_irq(ring->irq, ring_msix, irqflags, "thunderbolt", ring); 4377342ca34SJing Xiangfeng if (ret) 4387342ca34SJing Xiangfeng goto err_ida_remove; 4397342ca34SJing Xiangfeng 4407342ca34SJing Xiangfeng return 0; 4417342ca34SJing Xiangfeng 4427342ca34SJing Xiangfeng err_ida_remove: 4437342ca34SJing Xiangfeng ida_simple_remove(&nhi->msix_ida, ring->vector); 4447342ca34SJing Xiangfeng 4457342ca34SJing Xiangfeng return ret; 446046bee1fSMika Westerberg } 447046bee1fSMika Westerberg 448046bee1fSMika Westerberg static void ring_release_msix(struct tb_ring *ring) 449046bee1fSMika Westerberg { 450046bee1fSMika Westerberg if (ring->irq <= 0) 451046bee1fSMika Westerberg return; 452046bee1fSMika Westerberg 453046bee1fSMika Westerberg free_irq(ring->irq, ring); 454046bee1fSMika Westerberg ida_simple_remove(&ring->nhi->msix_ida, ring->vector); 455046bee1fSMika Westerberg ring->vector = 0; 456046bee1fSMika Westerberg ring->irq = 0; 457046bee1fSMika Westerberg } 458046bee1fSMika Westerberg 4599a01c7c2SMika Westerberg static int nhi_alloc_hop(struct tb_nhi *nhi, struct tb_ring *ring) 4609a01c7c2SMika Westerberg { 4619a01c7c2SMika Westerberg int ret = 0; 4629a01c7c2SMika Westerberg 4639a01c7c2SMika Westerberg spin_lock_irq(&nhi->lock); 4649a01c7c2SMika Westerberg 4659a01c7c2SMika Westerberg if (ring->hop < 0) { 4669a01c7c2SMika Westerberg unsigned int i; 4679a01c7c2SMika Westerberg 4689a01c7c2SMika Westerberg /* 4699a01c7c2SMika Westerberg * Automatically allocate HopID from the non-reserved 47053f13319SMika Westerberg * range 1 .. hop_count - 1. 4719a01c7c2SMika Westerberg */ 4729a01c7c2SMika Westerberg for (i = RING_FIRST_USABLE_HOPID; i < nhi->hop_count; i++) { 4739a01c7c2SMika Westerberg if (ring->is_tx) { 4749a01c7c2SMika Westerberg if (!nhi->tx_rings[i]) { 4759a01c7c2SMika Westerberg ring->hop = i; 4769a01c7c2SMika Westerberg break; 4779a01c7c2SMika Westerberg } 4789a01c7c2SMika Westerberg } else { 4799a01c7c2SMika Westerberg if (!nhi->rx_rings[i]) { 4809a01c7c2SMika Westerberg ring->hop = i; 4819a01c7c2SMika Westerberg break; 4829a01c7c2SMika Westerberg } 4839a01c7c2SMika Westerberg } 4849a01c7c2SMika Westerberg } 4859a01c7c2SMika Westerberg } 4869a01c7c2SMika Westerberg 4879a01c7c2SMika Westerberg if (ring->hop < 0 || ring->hop >= nhi->hop_count) { 4889a01c7c2SMika Westerberg dev_warn(&nhi->pdev->dev, "invalid hop: %d\n", ring->hop); 4899a01c7c2SMika Westerberg ret = -EINVAL; 4909a01c7c2SMika Westerberg goto err_unlock; 4919a01c7c2SMika Westerberg } 4929a01c7c2SMika Westerberg if (ring->is_tx && nhi->tx_rings[ring->hop]) { 4939a01c7c2SMika Westerberg dev_warn(&nhi->pdev->dev, "TX hop %d already allocated\n", 4949a01c7c2SMika Westerberg ring->hop); 4959a01c7c2SMika Westerberg ret = -EBUSY; 4969a01c7c2SMika Westerberg goto err_unlock; 4979a01c7c2SMika Westerberg } else if (!ring->is_tx && nhi->rx_rings[ring->hop]) { 4989a01c7c2SMika Westerberg dev_warn(&nhi->pdev->dev, "RX hop %d already allocated\n", 4999a01c7c2SMika Westerberg ring->hop); 5009a01c7c2SMika Westerberg ret = -EBUSY; 5019a01c7c2SMika Westerberg goto err_unlock; 5029a01c7c2SMika Westerberg } 5039a01c7c2SMika Westerberg 5049a01c7c2SMika Westerberg if (ring->is_tx) 5059a01c7c2SMika Westerberg nhi->tx_rings[ring->hop] = ring; 5069a01c7c2SMika Westerberg else 5079a01c7c2SMika Westerberg nhi->rx_rings[ring->hop] = ring; 5089a01c7c2SMika Westerberg 5099a01c7c2SMika Westerberg err_unlock: 5109a01c7c2SMika Westerberg spin_unlock_irq(&nhi->lock); 5119a01c7c2SMika Westerberg 5129a01c7c2SMika Westerberg return ret; 5139a01c7c2SMika Westerberg } 5149a01c7c2SMika Westerberg 5153b3d9f4dSMika Westerberg static struct tb_ring *tb_ring_alloc(struct tb_nhi *nhi, u32 hop, int size, 5169fb1e654SMika Westerberg bool transmit, unsigned int flags, 517afe704a2SMika Westerberg int e2e_tx_hop, u16 sof_mask, u16 eof_mask, 5184ffe722eSMika Westerberg void (*start_poll)(void *), 5194ffe722eSMika Westerberg void *poll_data) 52016603153SAndreas Noever { 52116603153SAndreas Noever struct tb_ring *ring = NULL; 522daa5140fSMika Westerberg 523daa5140fSMika Westerberg dev_dbg(&nhi->pdev->dev, "allocating %s ring %d of size %d\n", 52416603153SAndreas Noever transmit ? "TX" : "RX", hop, size); 52516603153SAndreas Noever 52616603153SAndreas Noever ring = kzalloc(sizeof(*ring), GFP_KERNEL); 52716603153SAndreas Noever if (!ring) 52859120e06SMika Westerberg return NULL; 52916603153SAndreas Noever 53022b7de10SMika Westerberg spin_lock_init(&ring->lock); 53116603153SAndreas Noever INIT_LIST_HEAD(&ring->queue); 53216603153SAndreas Noever INIT_LIST_HEAD(&ring->in_flight); 53316603153SAndreas Noever INIT_WORK(&ring->work, ring_work); 53416603153SAndreas Noever 53516603153SAndreas Noever ring->nhi = nhi; 53616603153SAndreas Noever ring->hop = hop; 53716603153SAndreas Noever ring->is_tx = transmit; 53816603153SAndreas Noever ring->size = size; 539046bee1fSMika Westerberg ring->flags = flags; 540afe704a2SMika Westerberg ring->e2e_tx_hop = e2e_tx_hop; 5419fb1e654SMika Westerberg ring->sof_mask = sof_mask; 5429fb1e654SMika Westerberg ring->eof_mask = eof_mask; 54316603153SAndreas Noever ring->head = 0; 54416603153SAndreas Noever ring->tail = 0; 54516603153SAndreas Noever ring->running = false; 5464ffe722eSMika Westerberg ring->start_poll = start_poll; 5474ffe722eSMika Westerberg ring->poll_data = poll_data; 548046bee1fSMika Westerberg 54916603153SAndreas Noever ring->descriptors = dma_alloc_coherent(&ring->nhi->pdev->dev, 55016603153SAndreas Noever size * sizeof(*ring->descriptors), 55116603153SAndreas Noever &ring->descriptors_dma, GFP_KERNEL | __GFP_ZERO); 55216603153SAndreas Noever if (!ring->descriptors) 55359120e06SMika Westerberg goto err_free_ring; 55416603153SAndreas Noever 55559120e06SMika Westerberg if (ring_request_msix(ring, flags & RING_FLAG_NO_SUSPEND)) 55659120e06SMika Westerberg goto err_free_descs; 55759120e06SMika Westerberg 5589a01c7c2SMika Westerberg if (nhi_alloc_hop(nhi, ring)) 55959120e06SMika Westerberg goto err_release_msix; 56059120e06SMika Westerberg 56116603153SAndreas Noever return ring; 56216603153SAndreas Noever 56359120e06SMika Westerberg err_release_msix: 56459120e06SMika Westerberg ring_release_msix(ring); 56559120e06SMika Westerberg err_free_descs: 56659120e06SMika Westerberg dma_free_coherent(&ring->nhi->pdev->dev, 56759120e06SMika Westerberg ring->size * sizeof(*ring->descriptors), 56859120e06SMika Westerberg ring->descriptors, ring->descriptors_dma); 56959120e06SMika Westerberg err_free_ring: 57016603153SAndreas Noever kfree(ring); 57159120e06SMika Westerberg 57216603153SAndreas Noever return NULL; 57316603153SAndreas Noever } 57416603153SAndreas Noever 5753b3d9f4dSMika Westerberg /** 5763b3d9f4dSMika Westerberg * tb_ring_alloc_tx() - Allocate DMA ring for transmit 5773b3d9f4dSMika Westerberg * @nhi: Pointer to the NHI the ring is to be allocated 5783b3d9f4dSMika Westerberg * @hop: HopID (ring) to allocate 5793b3d9f4dSMika Westerberg * @size: Number of entries in the ring 5803b3d9f4dSMika Westerberg * @flags: Flags for the ring 5813b3d9f4dSMika Westerberg */ 5823b3d9f4dSMika Westerberg struct tb_ring *tb_ring_alloc_tx(struct tb_nhi *nhi, int hop, int size, 583046bee1fSMika Westerberg unsigned int flags) 58416603153SAndreas Noever { 585afe704a2SMika Westerberg return tb_ring_alloc(nhi, hop, size, true, flags, 0, 0, 0, NULL, NULL); 58616603153SAndreas Noever } 5873b3d9f4dSMika Westerberg EXPORT_SYMBOL_GPL(tb_ring_alloc_tx); 58816603153SAndreas Noever 58916603153SAndreas Noever /** 5903b3d9f4dSMika Westerberg * tb_ring_alloc_rx() - Allocate DMA ring for receive 5913b3d9f4dSMika Westerberg * @nhi: Pointer to the NHI the ring is to be allocated 5929a01c7c2SMika Westerberg * @hop: HopID (ring) to allocate. Pass %-1 for automatic allocation. 5933b3d9f4dSMika Westerberg * @size: Number of entries in the ring 5943b3d9f4dSMika Westerberg * @flags: Flags for the ring 595afe704a2SMika Westerberg * @e2e_tx_hop: Transmit HopID when E2E is enabled in @flags 5963b3d9f4dSMika Westerberg * @sof_mask: Mask of PDF values that start a frame 5973b3d9f4dSMika Westerberg * @eof_mask: Mask of PDF values that end a frame 5984ffe722eSMika Westerberg * @start_poll: If not %NULL the ring will call this function when an 5994ffe722eSMika Westerberg * interrupt is triggered and masked, instead of callback 6004ffe722eSMika Westerberg * in each Rx frame. 6014ffe722eSMika Westerberg * @poll_data: Optional data passed to @start_poll 60216603153SAndreas Noever */ 6033b3d9f4dSMika Westerberg struct tb_ring *tb_ring_alloc_rx(struct tb_nhi *nhi, int hop, int size, 604afe704a2SMika Westerberg unsigned int flags, int e2e_tx_hop, 605afe704a2SMika Westerberg u16 sof_mask, u16 eof_mask, 6064ffe722eSMika Westerberg void (*start_poll)(void *), void *poll_data) 6073b3d9f4dSMika Westerberg { 608afe704a2SMika Westerberg return tb_ring_alloc(nhi, hop, size, false, flags, e2e_tx_hop, sof_mask, eof_mask, 6094ffe722eSMika Westerberg start_poll, poll_data); 6103b3d9f4dSMika Westerberg } 6113b3d9f4dSMika Westerberg EXPORT_SYMBOL_GPL(tb_ring_alloc_rx); 6123b3d9f4dSMika Westerberg 6133b3d9f4dSMika Westerberg /** 6143b3d9f4dSMika Westerberg * tb_ring_start() - enable a ring 6156894bd37SMika Westerberg * @ring: Ring to start 6163b3d9f4dSMika Westerberg * 6173b3d9f4dSMika Westerberg * Must not be invoked in parallel with tb_ring_stop(). 6183b3d9f4dSMika Westerberg */ 6193b3d9f4dSMika Westerberg void tb_ring_start(struct tb_ring *ring) 62016603153SAndreas Noever { 6219fb1e654SMika Westerberg u16 frame_size; 6229fb1e654SMika Westerberg u32 flags; 6239fb1e654SMika Westerberg 62459120e06SMika Westerberg spin_lock_irq(&ring->nhi->lock); 62559120e06SMika Westerberg spin_lock(&ring->lock); 626bdccf295SMika Westerberg if (ring->nhi->going_away) 627bdccf295SMika Westerberg goto err; 62816603153SAndreas Noever if (ring->running) { 62916603153SAndreas Noever dev_WARN(&ring->nhi->pdev->dev, "ring already started\n"); 63016603153SAndreas Noever goto err; 63116603153SAndreas Noever } 632daa5140fSMika Westerberg dev_dbg(&ring->nhi->pdev->dev, "starting %s %d\n", 63316603153SAndreas Noever RING_TYPE(ring), ring->hop); 63416603153SAndreas Noever 6359fb1e654SMika Westerberg if (ring->flags & RING_FLAG_FRAME) { 6369fb1e654SMika Westerberg /* Means 4096 */ 6379fb1e654SMika Westerberg frame_size = 0; 6389fb1e654SMika Westerberg flags = RING_FLAG_ENABLE; 6399fb1e654SMika Westerberg } else { 6409fb1e654SMika Westerberg frame_size = TB_FRAME_SIZE; 6419fb1e654SMika Westerberg flags = RING_FLAG_ENABLE | RING_FLAG_RAW; 6429fb1e654SMika Westerberg } 6439fb1e654SMika Westerberg 64416603153SAndreas Noever ring_iowrite64desc(ring, ring->descriptors_dma, 0); 64516603153SAndreas Noever if (ring->is_tx) { 64616603153SAndreas Noever ring_iowrite32desc(ring, ring->size, 12); 64716603153SAndreas Noever ring_iowrite32options(ring, 0, 4); /* time releated ? */ 6489fb1e654SMika Westerberg ring_iowrite32options(ring, flags, 0); 64916603153SAndreas Noever } else { 6509fb1e654SMika Westerberg u32 sof_eof_mask = ring->sof_mask << 16 | ring->eof_mask; 6519fb1e654SMika Westerberg 6529fb1e654SMika Westerberg ring_iowrite32desc(ring, (frame_size << 16) | ring->size, 12); 6539fb1e654SMika Westerberg ring_iowrite32options(ring, sof_eof_mask, 4); 6549fb1e654SMika Westerberg ring_iowrite32options(ring, flags, 0); 65516603153SAndreas Noever } 656afe704a2SMika Westerberg 657afe704a2SMika Westerberg /* 658afe704a2SMika Westerberg * Now that the ring valid bit is set we can configure E2E if 659afe704a2SMika Westerberg * enabled for the ring. 660afe704a2SMika Westerberg */ 661afe704a2SMika Westerberg if (ring->flags & RING_FLAG_E2E) { 662afe704a2SMika Westerberg if (!ring->is_tx) { 663afe704a2SMika Westerberg u32 hop; 664afe704a2SMika Westerberg 665afe704a2SMika Westerberg hop = ring->e2e_tx_hop << REG_RX_OPTIONS_E2E_HOP_SHIFT; 666afe704a2SMika Westerberg hop &= REG_RX_OPTIONS_E2E_HOP_MASK; 667afe704a2SMika Westerberg flags |= hop; 668afe704a2SMika Westerberg 669afe704a2SMika Westerberg dev_dbg(&ring->nhi->pdev->dev, 670afe704a2SMika Westerberg "enabling E2E for %s %d with TX HopID %d\n", 671afe704a2SMika Westerberg RING_TYPE(ring), ring->hop, ring->e2e_tx_hop); 672afe704a2SMika Westerberg } else { 673afe704a2SMika Westerberg dev_dbg(&ring->nhi->pdev->dev, "enabling E2E for %s %d\n", 674afe704a2SMika Westerberg RING_TYPE(ring), ring->hop); 675afe704a2SMika Westerberg } 676afe704a2SMika Westerberg 677afe704a2SMika Westerberg flags |= RING_FLAG_E2E_FLOW_CONTROL; 678afe704a2SMika Westerberg ring_iowrite32options(ring, flags, 0); 679afe704a2SMika Westerberg } 680afe704a2SMika Westerberg 68116603153SAndreas Noever ring_interrupt_active(ring, true); 68216603153SAndreas Noever ring->running = true; 68316603153SAndreas Noever err: 68459120e06SMika Westerberg spin_unlock(&ring->lock); 68559120e06SMika Westerberg spin_unlock_irq(&ring->nhi->lock); 68616603153SAndreas Noever } 6873b3d9f4dSMika Westerberg EXPORT_SYMBOL_GPL(tb_ring_start); 68816603153SAndreas Noever 68916603153SAndreas Noever /** 6903b3d9f4dSMika Westerberg * tb_ring_stop() - shutdown a ring 6916894bd37SMika Westerberg * @ring: Ring to stop 69216603153SAndreas Noever * 69316603153SAndreas Noever * Must not be invoked from a callback. 69416603153SAndreas Noever * 6953b3d9f4dSMika Westerberg * This method will disable the ring. Further calls to 6963b3d9f4dSMika Westerberg * tb_ring_tx/tb_ring_rx will return -ESHUTDOWN until ring_stop has been 6973b3d9f4dSMika Westerberg * called. 69816603153SAndreas Noever * 69916603153SAndreas Noever * All enqueued frames will be canceled and their callbacks will be executed 70016603153SAndreas Noever * with frame->canceled set to true (on the callback thread). This method 70116603153SAndreas Noever * returns only after all callback invocations have finished. 70216603153SAndreas Noever */ 7033b3d9f4dSMika Westerberg void tb_ring_stop(struct tb_ring *ring) 70416603153SAndreas Noever { 70559120e06SMika Westerberg spin_lock_irq(&ring->nhi->lock); 70659120e06SMika Westerberg spin_lock(&ring->lock); 707daa5140fSMika Westerberg dev_dbg(&ring->nhi->pdev->dev, "stopping %s %d\n", 70816603153SAndreas Noever RING_TYPE(ring), ring->hop); 709bdccf295SMika Westerberg if (ring->nhi->going_away) 710bdccf295SMika Westerberg goto err; 71116603153SAndreas Noever if (!ring->running) { 71216603153SAndreas Noever dev_WARN(&ring->nhi->pdev->dev, "%s %d already stopped\n", 71316603153SAndreas Noever RING_TYPE(ring), ring->hop); 71416603153SAndreas Noever goto err; 71516603153SAndreas Noever } 71616603153SAndreas Noever ring_interrupt_active(ring, false); 71716603153SAndreas Noever 71816603153SAndreas Noever ring_iowrite32options(ring, 0, 0); 71916603153SAndreas Noever ring_iowrite64desc(ring, 0, 0); 72094379521SMika Westerberg ring_iowrite32desc(ring, 0, 8); 72116603153SAndreas Noever ring_iowrite32desc(ring, 0, 12); 72216603153SAndreas Noever ring->head = 0; 72316603153SAndreas Noever ring->tail = 0; 72416603153SAndreas Noever ring->running = false; 72516603153SAndreas Noever 72616603153SAndreas Noever err: 72759120e06SMika Westerberg spin_unlock(&ring->lock); 72859120e06SMika Westerberg spin_unlock_irq(&ring->nhi->lock); 72916603153SAndreas Noever 73016603153SAndreas Noever /* 73116603153SAndreas Noever * schedule ring->work to invoke callbacks on all remaining frames. 73216603153SAndreas Noever */ 73316603153SAndreas Noever schedule_work(&ring->work); 73416603153SAndreas Noever flush_work(&ring->work); 73516603153SAndreas Noever } 7363b3d9f4dSMika Westerberg EXPORT_SYMBOL_GPL(tb_ring_stop); 73716603153SAndreas Noever 73816603153SAndreas Noever /* 7393b3d9f4dSMika Westerberg * tb_ring_free() - free ring 74016603153SAndreas Noever * 74116603153SAndreas Noever * When this method returns all invocations of ring->callback will have 74216603153SAndreas Noever * finished. 74316603153SAndreas Noever * 74416603153SAndreas Noever * Ring must be stopped. 74516603153SAndreas Noever * 74616603153SAndreas Noever * Must NOT be called from ring_frame->callback! 74716603153SAndreas Noever */ 7483b3d9f4dSMika Westerberg void tb_ring_free(struct tb_ring *ring) 74916603153SAndreas Noever { 75059120e06SMika Westerberg spin_lock_irq(&ring->nhi->lock); 75116603153SAndreas Noever /* 75216603153SAndreas Noever * Dissociate the ring from the NHI. This also ensures that 75316603153SAndreas Noever * nhi_interrupt_work cannot reschedule ring->work. 75416603153SAndreas Noever */ 75516603153SAndreas Noever if (ring->is_tx) 75616603153SAndreas Noever ring->nhi->tx_rings[ring->hop] = NULL; 75716603153SAndreas Noever else 75816603153SAndreas Noever ring->nhi->rx_rings[ring->hop] = NULL; 75916603153SAndreas Noever 76016603153SAndreas Noever if (ring->running) { 76116603153SAndreas Noever dev_WARN(&ring->nhi->pdev->dev, "%s %d still running\n", 76216603153SAndreas Noever RING_TYPE(ring), ring->hop); 76316603153SAndreas Noever } 7644ffe722eSMika Westerberg spin_unlock_irq(&ring->nhi->lock); 76516603153SAndreas Noever 766046bee1fSMika Westerberg ring_release_msix(ring); 767046bee1fSMika Westerberg 76816603153SAndreas Noever dma_free_coherent(&ring->nhi->pdev->dev, 76916603153SAndreas Noever ring->size * sizeof(*ring->descriptors), 77016603153SAndreas Noever ring->descriptors, ring->descriptors_dma); 77116603153SAndreas Noever 772f19b72c6SSachin Kamat ring->descriptors = NULL; 77316603153SAndreas Noever ring->descriptors_dma = 0; 77416603153SAndreas Noever 77516603153SAndreas Noever 776daa5140fSMika Westerberg dev_dbg(&ring->nhi->pdev->dev, "freeing %s %d\n", RING_TYPE(ring), 77716603153SAndreas Noever ring->hop); 77816603153SAndreas Noever 779a7bfb27bSLee Jones /* 780046bee1fSMika Westerberg * ring->work can no longer be scheduled (it is scheduled only 781046bee1fSMika Westerberg * by nhi_interrupt_work, ring_stop and ring_msix). Wait for it 782046bee1fSMika Westerberg * to finish before freeing the ring. 78316603153SAndreas Noever */ 78416603153SAndreas Noever flush_work(&ring->work); 78516603153SAndreas Noever kfree(ring); 78616603153SAndreas Noever } 7873b3d9f4dSMika Westerberg EXPORT_SYMBOL_GPL(tb_ring_free); 78816603153SAndreas Noever 789cd446ee2SMika Westerberg /** 790cd446ee2SMika Westerberg * nhi_mailbox_cmd() - Send a command through NHI mailbox 791cd446ee2SMika Westerberg * @nhi: Pointer to the NHI structure 792cd446ee2SMika Westerberg * @cmd: Command to send 793cd446ee2SMika Westerberg * @data: Data to be send with the command 794cd446ee2SMika Westerberg * 795cd446ee2SMika Westerberg * Sends mailbox command to the firmware running on NHI. Returns %0 in 796cd446ee2SMika Westerberg * case of success and negative errno in case of failure. 797cd446ee2SMika Westerberg */ 798cd446ee2SMika Westerberg int nhi_mailbox_cmd(struct tb_nhi *nhi, enum nhi_mailbox_cmd cmd, u32 data) 799cd446ee2SMika Westerberg { 800cd446ee2SMika Westerberg ktime_t timeout; 801cd446ee2SMika Westerberg u32 val; 802cd446ee2SMika Westerberg 803cd446ee2SMika Westerberg iowrite32(data, nhi->iobase + REG_INMAIL_DATA); 804cd446ee2SMika Westerberg 805cd446ee2SMika Westerberg val = ioread32(nhi->iobase + REG_INMAIL_CMD); 806cd446ee2SMika Westerberg val &= ~(REG_INMAIL_CMD_MASK | REG_INMAIL_ERROR); 807cd446ee2SMika Westerberg val |= REG_INMAIL_OP_REQUEST | cmd; 808cd446ee2SMika Westerberg iowrite32(val, nhi->iobase + REG_INMAIL_CMD); 809cd446ee2SMika Westerberg 810cd446ee2SMika Westerberg timeout = ktime_add_ms(ktime_get(), NHI_MAILBOX_TIMEOUT); 811cd446ee2SMika Westerberg do { 812cd446ee2SMika Westerberg val = ioread32(nhi->iobase + REG_INMAIL_CMD); 813cd446ee2SMika Westerberg if (!(val & REG_INMAIL_OP_REQUEST)) 814cd446ee2SMika Westerberg break; 815cd446ee2SMika Westerberg usleep_range(10, 20); 816cd446ee2SMika Westerberg } while (ktime_before(ktime_get(), timeout)); 817cd446ee2SMika Westerberg 818cd446ee2SMika Westerberg if (val & REG_INMAIL_OP_REQUEST) 819cd446ee2SMika Westerberg return -ETIMEDOUT; 820cd446ee2SMika Westerberg if (val & REG_INMAIL_ERROR) 821cd446ee2SMika Westerberg return -EIO; 822cd446ee2SMika Westerberg 823cd446ee2SMika Westerberg return 0; 824cd446ee2SMika Westerberg } 825cd446ee2SMika Westerberg 826cd446ee2SMika Westerberg /** 827cd446ee2SMika Westerberg * nhi_mailbox_mode() - Return current firmware operation mode 828cd446ee2SMika Westerberg * @nhi: Pointer to the NHI structure 829cd446ee2SMika Westerberg * 830cd446ee2SMika Westerberg * The function reads current firmware operation mode using NHI mailbox 831cd446ee2SMika Westerberg * registers and returns it to the caller. 832cd446ee2SMika Westerberg */ 833cd446ee2SMika Westerberg enum nhi_fw_mode nhi_mailbox_mode(struct tb_nhi *nhi) 834cd446ee2SMika Westerberg { 835cd446ee2SMika Westerberg u32 val; 836cd446ee2SMika Westerberg 837cd446ee2SMika Westerberg val = ioread32(nhi->iobase + REG_OUTMAIL_CMD); 838cd446ee2SMika Westerberg val &= REG_OUTMAIL_CMD_OPMODE_MASK; 839cd446ee2SMika Westerberg val >>= REG_OUTMAIL_CMD_OPMODE_SHIFT; 840cd446ee2SMika Westerberg 841cd446ee2SMika Westerberg return (enum nhi_fw_mode)val; 842cd446ee2SMika Westerberg } 843cd446ee2SMika Westerberg 84416603153SAndreas Noever static void nhi_interrupt_work(struct work_struct *work) 84516603153SAndreas Noever { 84616603153SAndreas Noever struct tb_nhi *nhi = container_of(work, typeof(*nhi), interrupt_work); 84716603153SAndreas Noever int value = 0; /* Suppress uninitialized usage warning. */ 84816603153SAndreas Noever int bit; 84916603153SAndreas Noever int hop = -1; 85016603153SAndreas Noever int type = 0; /* current interrupt type 0: TX, 1: RX, 2: RX overflow */ 85116603153SAndreas Noever struct tb_ring *ring; 85216603153SAndreas Noever 85359120e06SMika Westerberg spin_lock_irq(&nhi->lock); 85416603153SAndreas Noever 85516603153SAndreas Noever /* 85616603153SAndreas Noever * Starting at REG_RING_NOTIFY_BASE there are three status bitfields 85716603153SAndreas Noever * (TX, RX, RX overflow). We iterate over the bits and read a new 85816603153SAndreas Noever * dwords as required. The registers are cleared on read. 85916603153SAndreas Noever */ 86016603153SAndreas Noever for (bit = 0; bit < 3 * nhi->hop_count; bit++) { 86116603153SAndreas Noever if (bit % 32 == 0) 86216603153SAndreas Noever value = ioread32(nhi->iobase 86316603153SAndreas Noever + REG_RING_NOTIFY_BASE 86416603153SAndreas Noever + 4 * (bit / 32)); 86516603153SAndreas Noever if (++hop == nhi->hop_count) { 86616603153SAndreas Noever hop = 0; 86716603153SAndreas Noever type++; 86816603153SAndreas Noever } 86916603153SAndreas Noever if ((value & (1 << (bit % 32))) == 0) 87016603153SAndreas Noever continue; 87116603153SAndreas Noever if (type == 2) { 87216603153SAndreas Noever dev_warn(&nhi->pdev->dev, 87316603153SAndreas Noever "RX overflow for ring %d\n", 87416603153SAndreas Noever hop); 87516603153SAndreas Noever continue; 87616603153SAndreas Noever } 87716603153SAndreas Noever if (type == 0) 87816603153SAndreas Noever ring = nhi->tx_rings[hop]; 87916603153SAndreas Noever else 88016603153SAndreas Noever ring = nhi->rx_rings[hop]; 88116603153SAndreas Noever if (ring == NULL) { 88216603153SAndreas Noever dev_warn(&nhi->pdev->dev, 88316603153SAndreas Noever "got interrupt for inactive %s ring %d\n", 88416603153SAndreas Noever type ? "RX" : "TX", 88516603153SAndreas Noever hop); 88616603153SAndreas Noever continue; 88716603153SAndreas Noever } 8884ffe722eSMika Westerberg 8894ffe722eSMika Westerberg spin_lock(&ring->lock); 8904ffe722eSMika Westerberg __ring_interrupt(ring); 8914ffe722eSMika Westerberg spin_unlock(&ring->lock); 89216603153SAndreas Noever } 89359120e06SMika Westerberg spin_unlock_irq(&nhi->lock); 89416603153SAndreas Noever } 89516603153SAndreas Noever 89616603153SAndreas Noever static irqreturn_t nhi_msi(int irq, void *data) 89716603153SAndreas Noever { 89816603153SAndreas Noever struct tb_nhi *nhi = data; 89916603153SAndreas Noever schedule_work(&nhi->interrupt_work); 90016603153SAndreas Noever return IRQ_HANDLED; 90116603153SAndreas Noever } 90216603153SAndreas Noever 9033cdb9446SMika Westerberg static int __nhi_suspend_noirq(struct device *dev, bool wakeup) 90423dd5bb4SAndreas Noever { 90523dd5bb4SAndreas Noever struct pci_dev *pdev = to_pci_dev(dev); 90623dd5bb4SAndreas Noever struct tb *tb = pci_get_drvdata(pdev); 9073cdb9446SMika Westerberg struct tb_nhi *nhi = tb->nhi; 9083cdb9446SMika Westerberg int ret; 9099d3cce0bSMika Westerberg 9103cdb9446SMika Westerberg ret = tb_domain_suspend_noirq(tb); 9113cdb9446SMika Westerberg if (ret) 9123cdb9446SMika Westerberg return ret; 9133cdb9446SMika Westerberg 9143cdb9446SMika Westerberg if (nhi->ops && nhi->ops->suspend_noirq) { 9153cdb9446SMika Westerberg ret = nhi->ops->suspend_noirq(tb->nhi, wakeup); 9163cdb9446SMika Westerberg if (ret) 9173cdb9446SMika Westerberg return ret; 9183cdb9446SMika Westerberg } 9193cdb9446SMika Westerberg 9203cdb9446SMika Westerberg return 0; 9213cdb9446SMika Westerberg } 9223cdb9446SMika Westerberg 9233cdb9446SMika Westerberg static int nhi_suspend_noirq(struct device *dev) 9243cdb9446SMika Westerberg { 9253cdb9446SMika Westerberg return __nhi_suspend_noirq(dev, device_may_wakeup(dev)); 9263cdb9446SMika Westerberg } 9273cdb9446SMika Westerberg 928884e4d57SMika Westerberg static int nhi_freeze_noirq(struct device *dev) 929884e4d57SMika Westerberg { 930884e4d57SMika Westerberg struct pci_dev *pdev = to_pci_dev(dev); 931884e4d57SMika Westerberg struct tb *tb = pci_get_drvdata(pdev); 932884e4d57SMika Westerberg 933884e4d57SMika Westerberg return tb_domain_freeze_noirq(tb); 934884e4d57SMika Westerberg } 935884e4d57SMika Westerberg 936884e4d57SMika Westerberg static int nhi_thaw_noirq(struct device *dev) 937884e4d57SMika Westerberg { 938884e4d57SMika Westerberg struct pci_dev *pdev = to_pci_dev(dev); 939884e4d57SMika Westerberg struct tb *tb = pci_get_drvdata(pdev); 940884e4d57SMika Westerberg 941884e4d57SMika Westerberg return tb_domain_thaw_noirq(tb); 942884e4d57SMika Westerberg } 943884e4d57SMika Westerberg 9443cdb9446SMika Westerberg static bool nhi_wake_supported(struct pci_dev *pdev) 9453cdb9446SMika Westerberg { 9463cdb9446SMika Westerberg u8 val; 9473cdb9446SMika Westerberg 9483cdb9446SMika Westerberg /* 9493cdb9446SMika Westerberg * If power rails are sustainable for wakeup from S4 this 9503cdb9446SMika Westerberg * property is set by the BIOS. 9513cdb9446SMika Westerberg */ 9523cdb9446SMika Westerberg if (device_property_read_u8(&pdev->dev, "WAKE_SUPPORTED", &val)) 9533cdb9446SMika Westerberg return !!val; 9543cdb9446SMika Westerberg 9553cdb9446SMika Westerberg return true; 9563cdb9446SMika Westerberg } 9573cdb9446SMika Westerberg 9583cdb9446SMika Westerberg static int nhi_poweroff_noirq(struct device *dev) 9593cdb9446SMika Westerberg { 9603cdb9446SMika Westerberg struct pci_dev *pdev = to_pci_dev(dev); 9613cdb9446SMika Westerberg bool wakeup; 9623cdb9446SMika Westerberg 9633cdb9446SMika Westerberg wakeup = device_may_wakeup(dev) && nhi_wake_supported(pdev); 9643cdb9446SMika Westerberg return __nhi_suspend_noirq(dev, wakeup); 96523dd5bb4SAndreas Noever } 96623dd5bb4SAndreas Noever 9678c6bba10SMika Westerberg static void nhi_enable_int_throttling(struct tb_nhi *nhi) 9688c6bba10SMika Westerberg { 9698c6bba10SMika Westerberg /* Throttling is specified in 256ns increments */ 9708c6bba10SMika Westerberg u32 throttle = DIV_ROUND_UP(128 * NSEC_PER_USEC, 256); 9718c6bba10SMika Westerberg unsigned int i; 9728c6bba10SMika Westerberg 9738c6bba10SMika Westerberg /* 9748c6bba10SMika Westerberg * Configure interrupt throttling for all vectors even if we 9758c6bba10SMika Westerberg * only use few. 9768c6bba10SMika Westerberg */ 9778c6bba10SMika Westerberg for (i = 0; i < MSIX_MAX_VECS; i++) { 9788c6bba10SMika Westerberg u32 reg = REG_INT_THROTTLING_RATE + i * 4; 9798c6bba10SMika Westerberg iowrite32(throttle, nhi->iobase + reg); 9808c6bba10SMika Westerberg } 9818c6bba10SMika Westerberg } 9828c6bba10SMika Westerberg 98323dd5bb4SAndreas Noever static int nhi_resume_noirq(struct device *dev) 98423dd5bb4SAndreas Noever { 98523dd5bb4SAndreas Noever struct pci_dev *pdev = to_pci_dev(dev); 98623dd5bb4SAndreas Noever struct tb *tb = pci_get_drvdata(pdev); 9873cdb9446SMika Westerberg struct tb_nhi *nhi = tb->nhi; 9883cdb9446SMika Westerberg int ret; 9899d3cce0bSMika Westerberg 990bdccf295SMika Westerberg /* 991bdccf295SMika Westerberg * Check that the device is still there. It may be that the user 992bdccf295SMika Westerberg * unplugged last device which causes the host controller to go 993bdccf295SMika Westerberg * away on PCs. 994bdccf295SMika Westerberg */ 9953cdb9446SMika Westerberg if (!pci_device_is_present(pdev)) { 9963cdb9446SMika Westerberg nhi->going_away = true; 9973cdb9446SMika Westerberg } else { 9983cdb9446SMika Westerberg if (nhi->ops && nhi->ops->resume_noirq) { 9993cdb9446SMika Westerberg ret = nhi->ops->resume_noirq(nhi); 10003cdb9446SMika Westerberg if (ret) 10013cdb9446SMika Westerberg return ret; 10023cdb9446SMika Westerberg } 10038c6bba10SMika Westerberg nhi_enable_int_throttling(tb->nhi); 10043cdb9446SMika Westerberg } 1005bdccf295SMika Westerberg 10069d3cce0bSMika Westerberg return tb_domain_resume_noirq(tb); 100723dd5bb4SAndreas Noever } 100823dd5bb4SAndreas Noever 1009f67cf491SMika Westerberg static int nhi_suspend(struct device *dev) 1010f67cf491SMika Westerberg { 1011f67cf491SMika Westerberg struct pci_dev *pdev = to_pci_dev(dev); 1012f67cf491SMika Westerberg struct tb *tb = pci_get_drvdata(pdev); 1013f67cf491SMika Westerberg 1014f67cf491SMika Westerberg return tb_domain_suspend(tb); 1015f67cf491SMika Westerberg } 1016f67cf491SMika Westerberg 1017f67cf491SMika Westerberg static void nhi_complete(struct device *dev) 1018f67cf491SMika Westerberg { 1019f67cf491SMika Westerberg struct pci_dev *pdev = to_pci_dev(dev); 1020f67cf491SMika Westerberg struct tb *tb = pci_get_drvdata(pdev); 1021f67cf491SMika Westerberg 10222d8ff0b5SMika Westerberg /* 10232d8ff0b5SMika Westerberg * If we were runtime suspended when system suspend started, 10242d8ff0b5SMika Westerberg * schedule runtime resume now. It should bring the domain back 10252d8ff0b5SMika Westerberg * to functional state. 10262d8ff0b5SMika Westerberg */ 10272d8ff0b5SMika Westerberg if (pm_runtime_suspended(&pdev->dev)) 10282d8ff0b5SMika Westerberg pm_runtime_resume(&pdev->dev); 10292d8ff0b5SMika Westerberg else 1030f67cf491SMika Westerberg tb_domain_complete(tb); 1031f67cf491SMika Westerberg } 1032f67cf491SMika Westerberg 10332d8ff0b5SMika Westerberg static int nhi_runtime_suspend(struct device *dev) 10342d8ff0b5SMika Westerberg { 10352d8ff0b5SMika Westerberg struct pci_dev *pdev = to_pci_dev(dev); 10362d8ff0b5SMika Westerberg struct tb *tb = pci_get_drvdata(pdev); 10373cdb9446SMika Westerberg struct tb_nhi *nhi = tb->nhi; 10383cdb9446SMika Westerberg int ret; 10392d8ff0b5SMika Westerberg 10403cdb9446SMika Westerberg ret = tb_domain_runtime_suspend(tb); 10413cdb9446SMika Westerberg if (ret) 10423cdb9446SMika Westerberg return ret; 10433cdb9446SMika Westerberg 10443cdb9446SMika Westerberg if (nhi->ops && nhi->ops->runtime_suspend) { 10453cdb9446SMika Westerberg ret = nhi->ops->runtime_suspend(tb->nhi); 10463cdb9446SMika Westerberg if (ret) 10473cdb9446SMika Westerberg return ret; 10483cdb9446SMika Westerberg } 10493cdb9446SMika Westerberg return 0; 10502d8ff0b5SMika Westerberg } 10512d8ff0b5SMika Westerberg 10522d8ff0b5SMika Westerberg static int nhi_runtime_resume(struct device *dev) 10532d8ff0b5SMika Westerberg { 10542d8ff0b5SMika Westerberg struct pci_dev *pdev = to_pci_dev(dev); 10552d8ff0b5SMika Westerberg struct tb *tb = pci_get_drvdata(pdev); 10563cdb9446SMika Westerberg struct tb_nhi *nhi = tb->nhi; 10573cdb9446SMika Westerberg int ret; 10582d8ff0b5SMika Westerberg 10593cdb9446SMika Westerberg if (nhi->ops && nhi->ops->runtime_resume) { 10603cdb9446SMika Westerberg ret = nhi->ops->runtime_resume(nhi); 10613cdb9446SMika Westerberg if (ret) 10623cdb9446SMika Westerberg return ret; 10633cdb9446SMika Westerberg } 10643cdb9446SMika Westerberg 10653cdb9446SMika Westerberg nhi_enable_int_throttling(nhi); 10662d8ff0b5SMika Westerberg return tb_domain_runtime_resume(tb); 10672d8ff0b5SMika Westerberg } 10682d8ff0b5SMika Westerberg 106916603153SAndreas Noever static void nhi_shutdown(struct tb_nhi *nhi) 107016603153SAndreas Noever { 107116603153SAndreas Noever int i; 1072daa5140fSMika Westerberg 1073daa5140fSMika Westerberg dev_dbg(&nhi->pdev->dev, "shutdown\n"); 107416603153SAndreas Noever 107516603153SAndreas Noever for (i = 0; i < nhi->hop_count; i++) { 107616603153SAndreas Noever if (nhi->tx_rings[i]) 107716603153SAndreas Noever dev_WARN(&nhi->pdev->dev, 107816603153SAndreas Noever "TX ring %d is still active\n", i); 107916603153SAndreas Noever if (nhi->rx_rings[i]) 108016603153SAndreas Noever dev_WARN(&nhi->pdev->dev, 108116603153SAndreas Noever "RX ring %d is still active\n", i); 108216603153SAndreas Noever } 108316603153SAndreas Noever nhi_disable_interrupts(nhi); 108416603153SAndreas Noever /* 108516603153SAndreas Noever * We have to release the irq before calling flush_work. Otherwise an 108616603153SAndreas Noever * already executing IRQ handler could call schedule_work again. 108716603153SAndreas Noever */ 1088046bee1fSMika Westerberg if (!nhi->pdev->msix_enabled) { 108916603153SAndreas Noever devm_free_irq(&nhi->pdev->dev, nhi->pdev->irq, nhi); 109016603153SAndreas Noever flush_work(&nhi->interrupt_work); 1091046bee1fSMika Westerberg } 1092046bee1fSMika Westerberg ida_destroy(&nhi->msix_ida); 10933cdb9446SMika Westerberg 10943cdb9446SMika Westerberg if (nhi->ops && nhi->ops->shutdown) 10953cdb9446SMika Westerberg nhi->ops->shutdown(nhi); 1096046bee1fSMika Westerberg } 1097046bee1fSMika Westerberg 1098e390909aSSanjay R Mehta static void nhi_check_quirks(struct tb_nhi *nhi) 1099e390909aSSanjay R Mehta { 1100e390909aSSanjay R Mehta /* 1101e390909aSSanjay R Mehta * Intel hardware supports auto clear of the interrupt status 1102e390909aSSanjay R Mehta * reqister right after interrupt is being issued. 1103e390909aSSanjay R Mehta */ 1104e390909aSSanjay R Mehta if (nhi->pdev->vendor == PCI_VENDOR_ID_INTEL) 1105e390909aSSanjay R Mehta nhi->quirks |= QUIRK_AUTO_CLEAR_INT; 1106e390909aSSanjay R Mehta } 1107e390909aSSanjay R Mehta 110886eaf4a5SRobin Murphy static int nhi_check_iommu_pdev(struct pci_dev *pdev, void *data) 110986eaf4a5SRobin Murphy { 111086eaf4a5SRobin Murphy if (!pdev->external_facing || 111186eaf4a5SRobin Murphy !device_iommu_capable(&pdev->dev, IOMMU_CAP_PRE_BOOT_PROTECTION)) 111286eaf4a5SRobin Murphy return 0; 111386eaf4a5SRobin Murphy *(bool *)data = true; 111486eaf4a5SRobin Murphy return 1; /* Stop walking */ 111586eaf4a5SRobin Murphy } 111686eaf4a5SRobin Murphy 111786eaf4a5SRobin Murphy static void nhi_check_iommu(struct tb_nhi *nhi) 111886eaf4a5SRobin Murphy { 111986eaf4a5SRobin Murphy struct pci_bus *bus = nhi->pdev->bus; 112086eaf4a5SRobin Murphy bool port_ok = false; 112186eaf4a5SRobin Murphy 112286eaf4a5SRobin Murphy /* 112386eaf4a5SRobin Murphy * Ideally what we'd do here is grab every PCI device that 112486eaf4a5SRobin Murphy * represents a tunnelling adapter for this NHI and check their 112586eaf4a5SRobin Murphy * status directly, but unfortunately USB4 seems to make it 112686eaf4a5SRobin Murphy * obnoxiously difficult to reliably make any correlation. 112786eaf4a5SRobin Murphy * 112886eaf4a5SRobin Murphy * So for now we'll have to bodge it... Hoping that the system 112986eaf4a5SRobin Murphy * is at least sane enough that an adapter is in the same PCI 113086eaf4a5SRobin Murphy * segment as its NHI, if we can find *something* on that segment 113186eaf4a5SRobin Murphy * which meets the requirements for Kernel DMA Protection, we'll 113286eaf4a5SRobin Murphy * take that to imply that firmware is aware and has (hopefully) 113386eaf4a5SRobin Murphy * done the right thing in general. We need to know that the PCI 113486eaf4a5SRobin Murphy * layer has seen the ExternalFacingPort property which will then 113586eaf4a5SRobin Murphy * inform the IOMMU layer to enforce the complete "untrusted DMA" 113686eaf4a5SRobin Murphy * flow, but also that the IOMMU driver itself can be trusted not 113786eaf4a5SRobin Murphy * to have been subverted by a pre-boot DMA attack. 113886eaf4a5SRobin Murphy */ 113986eaf4a5SRobin Murphy while (bus->parent) 114086eaf4a5SRobin Murphy bus = bus->parent; 114186eaf4a5SRobin Murphy 114286eaf4a5SRobin Murphy pci_walk_bus(bus, nhi_check_iommu_pdev, &port_ok); 114386eaf4a5SRobin Murphy 114486eaf4a5SRobin Murphy nhi->iommu_dma_protection = port_ok; 114586eaf4a5SRobin Murphy dev_dbg(&nhi->pdev->dev, "IOMMU DMA protection is %s\n", 114686eaf4a5SRobin Murphy str_enabled_disabled(port_ok)); 114786eaf4a5SRobin Murphy } 114886eaf4a5SRobin Murphy 1149046bee1fSMika Westerberg static int nhi_init_msi(struct tb_nhi *nhi) 1150046bee1fSMika Westerberg { 1151046bee1fSMika Westerberg struct pci_dev *pdev = nhi->pdev; 1152046bee1fSMika Westerberg int res, irq, nvec; 1153046bee1fSMika Westerberg 1154046bee1fSMika Westerberg /* In case someone left them on. */ 1155046bee1fSMika Westerberg nhi_disable_interrupts(nhi); 1156046bee1fSMika Westerberg 11578c6bba10SMika Westerberg nhi_enable_int_throttling(nhi); 11588c6bba10SMika Westerberg 1159046bee1fSMika Westerberg ida_init(&nhi->msix_ida); 1160046bee1fSMika Westerberg 1161046bee1fSMika Westerberg /* 1162046bee1fSMika Westerberg * The NHI has 16 MSI-X vectors or a single MSI. We first try to 1163046bee1fSMika Westerberg * get all MSI-X vectors and if we succeed, each ring will have 1164046bee1fSMika Westerberg * one MSI-X. If for some reason that does not work out, we 1165046bee1fSMika Westerberg * fallback to a single MSI. 1166046bee1fSMika Westerberg */ 1167046bee1fSMika Westerberg nvec = pci_alloc_irq_vectors(pdev, MSIX_MIN_VECS, MSIX_MAX_VECS, 1168046bee1fSMika Westerberg PCI_IRQ_MSIX); 1169046bee1fSMika Westerberg if (nvec < 0) { 1170046bee1fSMika Westerberg nvec = pci_alloc_irq_vectors(pdev, 1, 1, PCI_IRQ_MSI); 1171046bee1fSMika Westerberg if (nvec < 0) 1172046bee1fSMika Westerberg return nvec; 1173046bee1fSMika Westerberg 1174046bee1fSMika Westerberg INIT_WORK(&nhi->interrupt_work, nhi_interrupt_work); 1175046bee1fSMika Westerberg 1176046bee1fSMika Westerberg irq = pci_irq_vector(nhi->pdev, 0); 1177046bee1fSMika Westerberg if (irq < 0) 1178046bee1fSMika Westerberg return irq; 1179046bee1fSMika Westerberg 1180046bee1fSMika Westerberg res = devm_request_irq(&pdev->dev, irq, nhi_msi, 1181046bee1fSMika Westerberg IRQF_NO_SUSPEND, "thunderbolt", nhi); 1182046bee1fSMika Westerberg if (res) { 1183046bee1fSMika Westerberg dev_err(&pdev->dev, "request_irq failed, aborting\n"); 1184046bee1fSMika Westerberg return res; 1185046bee1fSMika Westerberg } 1186046bee1fSMika Westerberg } 1187046bee1fSMika Westerberg 1188046bee1fSMika Westerberg return 0; 118916603153SAndreas Noever } 119016603153SAndreas Noever 11913cdb9446SMika Westerberg static bool nhi_imr_valid(struct pci_dev *pdev) 11923cdb9446SMika Westerberg { 11933cdb9446SMika Westerberg u8 val; 11943cdb9446SMika Westerberg 11953cdb9446SMika Westerberg if (!device_property_read_u8(&pdev->dev, "IMR_VALID", &val)) 11963cdb9446SMika Westerberg return !!val; 11973cdb9446SMika Westerberg 11983cdb9446SMika Westerberg return true; 11993cdb9446SMika Westerberg } 12003cdb9446SMika Westerberg 1201c6da62a2SMika Westerberg static struct tb *nhi_select_cm(struct tb_nhi *nhi) 1202c6da62a2SMika Westerberg { 1203c6da62a2SMika Westerberg struct tb *tb; 1204c6da62a2SMika Westerberg 1205c6da62a2SMika Westerberg /* 1206c6da62a2SMika Westerberg * USB4 case is simple. If we got control of any of the 1207c6da62a2SMika Westerberg * capabilities, we use software CM. 1208c6da62a2SMika Westerberg */ 1209c6da62a2SMika Westerberg if (tb_acpi_is_native()) 1210c6da62a2SMika Westerberg return tb_probe(nhi); 1211c6da62a2SMika Westerberg 1212c6da62a2SMika Westerberg /* 1213c6da62a2SMika Westerberg * Either firmware based CM is running (we did not get control 1214c6da62a2SMika Westerberg * from the firmware) or this is pre-USB4 PC so try first 1215c6da62a2SMika Westerberg * firmware CM and then fallback to software CM. 1216c6da62a2SMika Westerberg */ 1217c6da62a2SMika Westerberg tb = icm_probe(nhi); 1218c6da62a2SMika Westerberg if (!tb) 1219c6da62a2SMika Westerberg tb = tb_probe(nhi); 1220c6da62a2SMika Westerberg 1221c6da62a2SMika Westerberg return tb; 1222c6da62a2SMika Westerberg } 1223c6da62a2SMika Westerberg 122416603153SAndreas Noever static int nhi_probe(struct pci_dev *pdev, const struct pci_device_id *id) 122516603153SAndreas Noever { 122616603153SAndreas Noever struct tb_nhi *nhi; 1227d6cc51cdSAndreas Noever struct tb *tb; 122816603153SAndreas Noever int res; 122916603153SAndreas Noever 12303cdb9446SMika Westerberg if (!nhi_imr_valid(pdev)) { 12313cdb9446SMika Westerberg dev_warn(&pdev->dev, "firmware image not valid, aborting\n"); 12323cdb9446SMika Westerberg return -ENODEV; 12333cdb9446SMika Westerberg } 12343cdb9446SMika Westerberg 123516603153SAndreas Noever res = pcim_enable_device(pdev); 123616603153SAndreas Noever if (res) { 123716603153SAndreas Noever dev_err(&pdev->dev, "cannot enable PCI device, aborting\n"); 123816603153SAndreas Noever return res; 123916603153SAndreas Noever } 124016603153SAndreas Noever 124116603153SAndreas Noever res = pcim_iomap_regions(pdev, 1 << 0, "thunderbolt"); 124216603153SAndreas Noever if (res) { 124316603153SAndreas Noever dev_err(&pdev->dev, "cannot obtain PCI resources, aborting\n"); 124416603153SAndreas Noever return res; 124516603153SAndreas Noever } 124616603153SAndreas Noever 124716603153SAndreas Noever nhi = devm_kzalloc(&pdev->dev, sizeof(*nhi), GFP_KERNEL); 124816603153SAndreas Noever if (!nhi) 124916603153SAndreas Noever return -ENOMEM; 125016603153SAndreas Noever 125116603153SAndreas Noever nhi->pdev = pdev; 12523cdb9446SMika Westerberg nhi->ops = (const struct tb_nhi_ops *)id->driver_data; 1253ca319f55SMika Westerberg /* cannot fail - table is allocated in pcim_iomap_regions */ 125416603153SAndreas Noever nhi->iobase = pcim_iomap_table(pdev)[0]; 125516603153SAndreas Noever nhi->hop_count = ioread32(nhi->iobase + REG_HOP_COUNT) & 0x3ff; 1256177aa362SMika Westerberg dev_dbg(&pdev->dev, "total paths: %d\n", nhi->hop_count); 125716603153SAndreas Noever 12582a211f32SHimangi Saraogi nhi->tx_rings = devm_kcalloc(&pdev->dev, nhi->hop_count, 12592a211f32SHimangi Saraogi sizeof(*nhi->tx_rings), GFP_KERNEL); 12602a211f32SHimangi Saraogi nhi->rx_rings = devm_kcalloc(&pdev->dev, nhi->hop_count, 12612a211f32SHimangi Saraogi sizeof(*nhi->rx_rings), GFP_KERNEL); 126216603153SAndreas Noever if (!nhi->tx_rings || !nhi->rx_rings) 126316603153SAndreas Noever return -ENOMEM; 126416603153SAndreas Noever 1265e390909aSSanjay R Mehta nhi_check_quirks(nhi); 126686eaf4a5SRobin Murphy nhi_check_iommu(nhi); 1267e390909aSSanjay R Mehta 1268046bee1fSMika Westerberg res = nhi_init_msi(nhi); 126916603153SAndreas Noever if (res) { 1270046bee1fSMika Westerberg dev_err(&pdev->dev, "cannot enable MSI, aborting\n"); 127116603153SAndreas Noever return res; 127216603153SAndreas Noever } 127316603153SAndreas Noever 127459120e06SMika Westerberg spin_lock_init(&nhi->lock); 127516603153SAndreas Noever 1276dba3caf6SMika Westerberg res = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(64)); 1277dba3caf6SMika Westerberg if (res) { 1278dba3caf6SMika Westerberg dev_err(&pdev->dev, "failed to set DMA mask\n"); 1279dba3caf6SMika Westerberg return res; 1280dba3caf6SMika Westerberg } 1281dba3caf6SMika Westerberg 128216603153SAndreas Noever pci_set_master(pdev); 128316603153SAndreas Noever 12843cdb9446SMika Westerberg if (nhi->ops && nhi->ops->init) { 12853cdb9446SMika Westerberg res = nhi->ops->init(nhi); 12863cdb9446SMika Westerberg if (res) 12873cdb9446SMika Westerberg return res; 12883cdb9446SMika Westerberg } 12893cdb9446SMika Westerberg 1290c6da62a2SMika Westerberg tb = nhi_select_cm(nhi); 1291f67cf491SMika Westerberg if (!tb) { 1292f67cf491SMika Westerberg dev_err(&nhi->pdev->dev, 1293f67cf491SMika Westerberg "failed to determine connection manager, aborting\n"); 12949d3cce0bSMika Westerberg return -ENODEV; 1295f67cf491SMika Westerberg } 1296f67cf491SMika Westerberg 1297daa5140fSMika Westerberg dev_dbg(&nhi->pdev->dev, "NHI initialized, starting thunderbolt\n"); 12989d3cce0bSMika Westerberg 12999d3cce0bSMika Westerberg res = tb_domain_add(tb); 13009d3cce0bSMika Westerberg if (res) { 1301d6cc51cdSAndreas Noever /* 1302d6cc51cdSAndreas Noever * At this point the RX/TX rings might already have been 1303d6cc51cdSAndreas Noever * activated. Do a proper shutdown. 1304d6cc51cdSAndreas Noever */ 13059d3cce0bSMika Westerberg tb_domain_put(tb); 1306d6cc51cdSAndreas Noever nhi_shutdown(nhi); 130768a7a2acSMika Westerberg return res; 1308d6cc51cdSAndreas Noever } 1309d6cc51cdSAndreas Noever pci_set_drvdata(pdev, tb); 131016603153SAndreas Noever 1311b2911a59SMika Westerberg device_wakeup_enable(&pdev->dev); 1312b2911a59SMika Westerberg 13132d8ff0b5SMika Westerberg pm_runtime_allow(&pdev->dev); 13142d8ff0b5SMika Westerberg pm_runtime_set_autosuspend_delay(&pdev->dev, TB_AUTOSUSPEND_DELAY); 13152d8ff0b5SMika Westerberg pm_runtime_use_autosuspend(&pdev->dev); 13162d8ff0b5SMika Westerberg pm_runtime_put_autosuspend(&pdev->dev); 13172d8ff0b5SMika Westerberg 131816603153SAndreas Noever return 0; 131916603153SAndreas Noever } 132016603153SAndreas Noever 132116603153SAndreas Noever static void nhi_remove(struct pci_dev *pdev) 132216603153SAndreas Noever { 1323d6cc51cdSAndreas Noever struct tb *tb = pci_get_drvdata(pdev); 1324d6cc51cdSAndreas Noever struct tb_nhi *nhi = tb->nhi; 13259d3cce0bSMika Westerberg 13262d8ff0b5SMika Westerberg pm_runtime_get_sync(&pdev->dev); 13272d8ff0b5SMika Westerberg pm_runtime_dont_use_autosuspend(&pdev->dev); 13282d8ff0b5SMika Westerberg pm_runtime_forbid(&pdev->dev); 13292d8ff0b5SMika Westerberg 13309d3cce0bSMika Westerberg tb_domain_remove(tb); 133116603153SAndreas Noever nhi_shutdown(nhi); 133216603153SAndreas Noever } 133316603153SAndreas Noever 133423dd5bb4SAndreas Noever /* 133523dd5bb4SAndreas Noever * The tunneled pci bridges are siblings of us. Use resume_noirq to reenable 133623dd5bb4SAndreas Noever * the tunnels asap. A corresponding pci quirk blocks the downstream bridges 133723dd5bb4SAndreas Noever * resume_noirq until we are done. 133823dd5bb4SAndreas Noever */ 133923dd5bb4SAndreas Noever static const struct dev_pm_ops nhi_pm_ops = { 134023dd5bb4SAndreas Noever .suspend_noirq = nhi_suspend_noirq, 134123dd5bb4SAndreas Noever .resume_noirq = nhi_resume_noirq, 1342884e4d57SMika Westerberg .freeze_noirq = nhi_freeze_noirq, /* 134323dd5bb4SAndreas Noever * we just disable hotplug, the 134423dd5bb4SAndreas Noever * pci-tunnels stay alive. 134523dd5bb4SAndreas Noever */ 1346884e4d57SMika Westerberg .thaw_noirq = nhi_thaw_noirq, 134723dd5bb4SAndreas Noever .restore_noirq = nhi_resume_noirq, 1348f67cf491SMika Westerberg .suspend = nhi_suspend, 13493cdb9446SMika Westerberg .poweroff_noirq = nhi_poweroff_noirq, 1350f67cf491SMika Westerberg .poweroff = nhi_suspend, 1351f67cf491SMika Westerberg .complete = nhi_complete, 13522d8ff0b5SMika Westerberg .runtime_suspend = nhi_runtime_suspend, 13532d8ff0b5SMika Westerberg .runtime_resume = nhi_runtime_resume, 135423dd5bb4SAndreas Noever }; 135523dd5bb4SAndreas Noever 1356620863f7SSachin Kamat static struct pci_device_id nhi_ids[] = { 135716603153SAndreas Noever /* 135816603153SAndreas Noever * We have to specify class, the TB bridges use the same device and 13591d111406SLukas Wunner * vendor (sub)id on gen 1 and gen 2 controllers. 136016603153SAndreas Noever */ 136116603153SAndreas Noever { 136216603153SAndreas Noever .class = PCI_CLASS_SYSTEM_OTHER << 8, .class_mask = ~0, 13631d111406SLukas Wunner .vendor = PCI_VENDOR_ID_INTEL, 136419bf4d4fSLukas Wunner .device = PCI_DEVICE_ID_INTEL_LIGHT_RIDGE, 136519bf4d4fSLukas Wunner .subvendor = 0x2222, .subdevice = 0x1111, 136619bf4d4fSLukas Wunner }, 136719bf4d4fSLukas Wunner { 136819bf4d4fSLukas Wunner .class = PCI_CLASS_SYSTEM_OTHER << 8, .class_mask = ~0, 136919bf4d4fSLukas Wunner .vendor = PCI_VENDOR_ID_INTEL, 13701d111406SLukas Wunner .device = PCI_DEVICE_ID_INTEL_CACTUS_RIDGE_4C, 137116603153SAndreas Noever .subvendor = 0x2222, .subdevice = 0x1111, 137216603153SAndreas Noever }, 137316603153SAndreas Noever { 137416603153SAndreas Noever .class = PCI_CLASS_SYSTEM_OTHER << 8, .class_mask = ~0, 13751d111406SLukas Wunner .vendor = PCI_VENDOR_ID_INTEL, 137682a6a81cSXavier Gnata .device = PCI_DEVICE_ID_INTEL_FALCON_RIDGE_2C_NHI, 137782a6a81cSXavier Gnata .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID, 137882a6a81cSXavier Gnata }, 137982a6a81cSXavier Gnata { 138082a6a81cSXavier Gnata .class = PCI_CLASS_SYSTEM_OTHER << 8, .class_mask = ~0, 138182a6a81cSXavier Gnata .vendor = PCI_VENDOR_ID_INTEL, 13821d111406SLukas Wunner .device = PCI_DEVICE_ID_INTEL_FALCON_RIDGE_4C_NHI, 1383a42fb351SKnuth Posern .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID, 138416603153SAndreas Noever }, 13855e2781bcSMika Westerberg 13865e2781bcSMika Westerberg /* Thunderbolt 3 */ 13875e2781bcSMika Westerberg { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_2C_NHI) }, 13885e2781bcSMika Westerberg { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_4C_NHI) }, 13895e2781bcSMika Westerberg { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_USBONLY_NHI) }, 13905e2781bcSMika Westerberg { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_LP_NHI) }, 13915e2781bcSMika Westerberg { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_LP_USBONLY_NHI) }, 13925e2781bcSMika Westerberg { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_C_2C_NHI) }, 13935e2781bcSMika Westerberg { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_C_4C_NHI) }, 13945e2781bcSMika Westerberg { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_C_USBONLY_NHI) }, 13954bac471dSRadion Mirchevsky { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_TITAN_RIDGE_2C_NHI) }, 13964bac471dSRadion Mirchevsky { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_TITAN_RIDGE_4C_NHI) }, 13973cdb9446SMika Westerberg { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_ICL_NHI0), 13983cdb9446SMika Westerberg .driver_data = (kernel_ulong_t)&icl_nhi_ops }, 13993cdb9446SMika Westerberg { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_ICL_NHI1), 14003cdb9446SMika Westerberg .driver_data = (kernel_ulong_t)&icl_nhi_ops }, 1401*1c1aac98SMika Westerberg /* Thunderbolt 4 */ 140257d8df68SMika Westerberg { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_TGL_NHI0), 140357d8df68SMika Westerberg .driver_data = (kernel_ulong_t)&icl_nhi_ops }, 140457d8df68SMika Westerberg { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_TGL_NHI1), 140557d8df68SMika Westerberg .driver_data = (kernel_ulong_t)&icl_nhi_ops }, 1406f6439c53SMika Westerberg { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_TGL_H_NHI0), 1407f6439c53SMika Westerberg .driver_data = (kernel_ulong_t)&icl_nhi_ops }, 1408f6439c53SMika Westerberg { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_TGL_H_NHI1), 1409f6439c53SMika Westerberg .driver_data = (kernel_ulong_t)&icl_nhi_ops }, 141013579486SAzhar Shaikh { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_ADL_NHI0), 141113579486SAzhar Shaikh .driver_data = (kernel_ulong_t)&icl_nhi_ops }, 141213579486SAzhar Shaikh { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_ADL_NHI1), 141313579486SAzhar Shaikh .driver_data = (kernel_ulong_t)&icl_nhi_ops }, 14147ec58378SGeorge D Sworo { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_RPL_NHI0), 14157ec58378SGeorge D Sworo .driver_data = (kernel_ulong_t)&icl_nhi_ops }, 14167ec58378SGeorge D Sworo { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_RPL_NHI1), 14177ec58378SGeorge D Sworo .driver_data = (kernel_ulong_t)&icl_nhi_ops }, 14185e2781bcSMika Westerberg 1419b0407983SMika Westerberg /* Any USB4 compliant host */ 1420b0407983SMika Westerberg { PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_USB4, ~0) }, 1421b0407983SMika Westerberg 142216603153SAndreas Noever { 0,} 142316603153SAndreas Noever }; 142416603153SAndreas Noever 142516603153SAndreas Noever MODULE_DEVICE_TABLE(pci, nhi_ids); 142616603153SAndreas Noever MODULE_LICENSE("GPL"); 142716603153SAndreas Noever 142816603153SAndreas Noever static struct pci_driver nhi_driver = { 142916603153SAndreas Noever .name = "thunderbolt", 143016603153SAndreas Noever .id_table = nhi_ids, 143116603153SAndreas Noever .probe = nhi_probe, 143216603153SAndreas Noever .remove = nhi_remove, 14334caf2511SMaxim Levitsky .shutdown = nhi_remove, 143423dd5bb4SAndreas Noever .driver.pm = &nhi_pm_ops, 143516603153SAndreas Noever }; 143616603153SAndreas Noever 143716603153SAndreas Noever static int __init nhi_init(void) 143816603153SAndreas Noever { 14399d3cce0bSMika Westerberg int ret; 14409d3cce0bSMika Westerberg 14419d3cce0bSMika Westerberg ret = tb_domain_init(); 14429d3cce0bSMika Westerberg if (ret) 14439d3cce0bSMika Westerberg return ret; 14449d3cce0bSMika Westerberg ret = pci_register_driver(&nhi_driver); 14459d3cce0bSMika Westerberg if (ret) 14469d3cce0bSMika Westerberg tb_domain_exit(); 14479d3cce0bSMika Westerberg return ret; 144816603153SAndreas Noever } 144916603153SAndreas Noever 145016603153SAndreas Noever static void __exit nhi_unload(void) 145116603153SAndreas Noever { 145216603153SAndreas Noever pci_unregister_driver(&nhi_driver); 14539d3cce0bSMika Westerberg tb_domain_exit(); 145416603153SAndreas Noever } 145516603153SAndreas Noever 1456eafa717bSMika Westerberg rootfs_initcall(nhi_init); 145716603153SAndreas Noever module_exit(nhi_unload); 1458