/* * SL811HS register declarations and HCD data structures * * Copyright (C) 2004 Psion Teklogix * Copyright (C) 2004 David Brownell * Copyright (C) 2001 Cypress Semiconductor Inc. */ /* * SL811HS has transfer registers, and control registers. In host/master * mode one set of registers is used; in peripheral/slave mode, another. * - SL11H only has some "A" transfer registers from 0x00-0x04 * - SL811HS also has "B" registers from 0x08-0x0c * - SL811S (or HS in slave mode) has four A+B sets, at 00, 10, 20, 30 */ #define SL811_EP_A(base) ((base) + 0) #define SL811_EP_B(base) ((base) + 8) #define SL811_HOST_BUF 0x00 #define SL811_PERIPH_EP0 0x00 #define SL811_PERIPH_EP1 0x10 #define SL811_PERIPH_EP2 0x20 #define SL811_PERIPH_EP3 0x30 /* TRANSFER REGISTERS: host and peripheral sides are similar * except for the control models (master vs slave). */ #define SL11H_HOSTCTLREG 0 # define SL11H_HCTLMASK_ARM 0x01 # define SL11H_HCTLMASK_ENABLE 0x02 # define SL11H_HCTLMASK_IN 0x00 # define SL11H_HCTLMASK_OUT 0x04 # define SL11H_HCTLMASK_ISOCH 0x10 # define SL11H_HCTLMASK_AFTERSOF 0x20 # define SL11H_HCTLMASK_TOGGLE 0x40 # define SL11H_HCTLMASK_PREAMBLE 0x80 #define SL11H_BUFADDRREG 1 #define SL11H_BUFLNTHREG 2 #define SL11H_PKTSTATREG 3 /* read */ # define SL11H_STATMASK_ACK 0x01 # define SL11H_STATMASK_ERROR 0x02 # define SL11H_STATMASK_TMOUT 0x04 # define SL11H_STATMASK_SEQ 0x08 # define SL11H_STATMASK_SETUP 0x10 # define SL11H_STATMASK_OVF 0x20 # define SL11H_STATMASK_NAK 0x40 # define SL11H_STATMASK_STALL 0x80 #define SL11H_PIDEPREG 3 /* write */ # define SL_SETUP 0xd0 # define SL_IN 0x90 # define SL_OUT 0x10 # define SL_SOF 0x50 # define SL_PREAMBLE 0xc0 # define SL_NAK 0xa0 # define SL_STALL 0xe0 # define SL_DATA0 0x30 # define SL_DATA1 0xb0 #define SL11H_XFERCNTREG 4 /* read */ #define SL11H_DEVADDRREG 4 /* write */ /* CONTROL REGISTERS: host and peripheral are very different. */ #define SL11H_CTLREG1 5 # define SL11H_CTL1MASK_SOF_ENA 0x01 # define SL11H_CTL1MASK_FORCE 0x18 # define SL11H_CTL1MASK_NORMAL 0x00 # define SL11H_CTL1MASK_SE0 0x08 /* reset */ # define SL11H_CTL1MASK_J 0x10 # define SL11H_CTL1MASK_K 0x18 /* resume */ # define SL11H_CTL1MASK_LSPD 0x20 # define SL11H_CTL1MASK_SUSPEND 0x40 #define SL11H_IRQ_ENABLE 6 # define SL11H_INTMASK_DONE_A 0x01 # define SL11H_INTMASK_DONE_B 0x02 # define SL11H_INTMASK_SOFINTR 0x10 # define SL11H_INTMASK_INSRMV 0x20 /* to/from SE0 */ # define SL11H_INTMASK_RD 0x40 # define SL11H_INTMASK_DP 0x80 /* only in INTSTATREG */ #define SL11S_ADDRESS 7 /* 0x08-0x0c are for the B buffer (not in SL11) */ #define SL11H_IRQ_STATUS 0x0D /* write to ack */ #define SL11H_HWREVREG 0x0E /* read */ # define SL11H_HWRMASK_HWREV 0xF0 #define SL11H_SOFLOWREG 0x0E /* write */ #define SL11H_SOFTMRREG 0x0F /* read */ /* a write to this register enables SL811HS features. * HOST flag presumably overrides the chip input signal? */ #define SL811HS_CTLREG2 0x0F # define SL811HS_CTL2MASK_SOF_MASK 0x3F # define SL811HS_CTL2MASK_DSWAP 0x40 # define SL811HS_CTL2MASK_HOST 0x80 #define SL811HS_CTL2_INIT (SL811HS_CTL2MASK_HOST | 0x2e) /* DATA BUFFERS: registers from 0x10..0xff are for data buffers; * that's 240 bytes, which we'll split evenly between A and B sides. * Only ISO can use more than 64 bytes per packet. * (The SL11S has 0x40..0xff for buffers.) */ #define H_MAXPACKET 120 /* bytes in A or B fifos */ #define SL11H_DATA_START 0x10 #define SL811HS_PACKET_BUF(is_a) ((is_a) \ ? SL11H_DATA_START \ : (SL11H_DATA_START + H_MAXPACKET)) /*-------------------------------------------------------------------------*/ #define LOG2_PERIODIC_SIZE 5 /* arbitrary; this matches OHCI */ #define PERIODIC_SIZE (1 << LOG2_PERIODIC_SIZE) struct sl811 { spinlock_t lock; void __iomem *addr_reg; void __iomem *data_reg; struct sl811_platform_data *board; struct dentry *debug_file; unsigned long stat_insrmv; unsigned long stat_wake; unsigned long stat_sof; unsigned long stat_a; unsigned long stat_b; unsigned long stat_lost; unsigned long stat_overrun; /* sw model */ struct timer_list timer; struct sl811h_ep *next_periodic; struct sl811h_ep *next_async; struct sl811h_ep *active_a; unsigned long jiffies_a; struct sl811h_ep *active_b; unsigned long jiffies_b; u32 port1; u8 ctrl1, ctrl2, irq_enable; u16 frame; /* async schedule: control, bulk */ struct list_head async; /* periodic schedule: interrupt, iso */ u16 load[PERIODIC_SIZE]; struct sl811h_ep *periodic[PERIODIC_SIZE]; unsigned periodic_count; }; static inline struct sl811 *hcd_to_sl811(struct usb_hcd *hcd) { return (struct sl811 *) (hcd->hcd_priv); } static inline struct usb_hcd *sl811_to_hcd(struct sl811 *sl811) { return container_of((void *) sl811, struct usb_hcd, hcd_priv); } struct sl811h_ep { struct usb_host_endpoint *hep; struct usb_device *udev; u8 defctrl; u8 maxpacket; u8 epnum; u8 nextpid; u16 error_count; u16 nak_count; u16 length; /* of current packet */ /* periodic schedule */ u16 period; u16 branch; u16 load; struct sl811h_ep *next; /* async schedule */ struct list_head schedule; }; /*-------------------------------------------------------------------------*/ /* These register utilities should work for the SL811S register API too * NOTE: caller must hold sl811->lock. */ static inline u8 sl811_read(struct sl811 *sl811, int reg) { writeb(reg, sl811->addr_reg); return readb(sl811->data_reg); } static inline void sl811_write(struct sl811 *sl811, int reg, u8 val) { writeb(reg, sl811->addr_reg); writeb(val, sl811->data_reg); } static inline void sl811_write_buf(struct sl811 *sl811, int addr, const void *buf, size_t count) { const u8 *data; void __iomem *data_reg; if (!count) return; writeb(addr, sl811->addr_reg); data = buf; data_reg = sl811->data_reg; do { writeb(*data++, data_reg); } while (--count); } static inline void sl811_read_buf(struct sl811 *sl811, int addr, void *buf, size_t count) { u8 *data; void __iomem *data_reg; if (!count) return; writeb(addr, sl811->addr_reg); data = buf; data_reg = sl811->data_reg; do { *data++ = readb(data_reg); } while (--count); } /*-------------------------------------------------------------------------*/ #ifdef PACKET_TRACE # define PACKET pr_debug("sl811: "stuff) #else # define PACKET(stuff...) do{}while(0) #endif ling of fw_state_wait() return value") fw_load_abort() could be called twice and lead us to a kernel crash. This happens only when the firmware fallback mechanism (regular or custom) is used. The fallback mechanism exposes a sysfs interface for userspace to upload a file and notify the kernel when the file is loaded and ready, or to cancel an upload by echo'ing -1 into on the loading file: echo -n "-1" > /sys/$DEVPATH/loading This will call fw_load_abort(). Some distributions actually have a udev rule in place to *always* immediately cancel all firmware fallback mechanism requests (Debian), they have: $ cat /lib/udev/rules.d/50-firmware.rules # stub for immediately telling the kernel that userspace firmware loading # failed; necessary to avoid long timeouts with CONFIG_FW_LOADER_USER_HELPER=y SUBSYSTEM=="firmware", ACTION=="add", ATTR{loading}="-1 Distributions with this udev rule would run into this crash only if the fallback mechanism is used. Since most distributions disable by default using the fallback mechanism (CONFIG_FW_LOADER_USER_HELPER_FALLBACK), this would typicaly mean only 2 drivers which *require* the fallback mechanism could typically incur a crash: drivers/firmware/dell_rbu.c and the drivers/leds/leds-lp55xx-common.c driver. Distributions enabling CONFIG_FW_LOADER_USER_HELPER_FALLBACK by default are obviously more exposed to this crash. The crash happens because after commit 5b029624948d ("firmware: do not use fw_lock for fw_state protection") and subsequent fix commit 5d47ec02c37ea6 ("firmware: Correct handling of fw_state_wait() return value") a race can happen between this cancelation and the firmware fw_state_wait_timeout() being woken up after a state change with which fw_load_abort() as that calls swake_up(). Upon error fw_state_wait_timeout() will also again call fw_load_abort() and trigger a null reference. At first glance we could just fix this with a !buf check on fw_load_abort() before accessing buf->fw_st, however there is a logical issue in having a state machine used for the fallback mechanism and preventing access from it once we abort as its inside the buf (buf->fw_st). The firmware_class.c code is setting the buf to NULL to annotate an abort has occurred. Replace this mechanism by simply using the state check instead. All the other code in place already uses similar checks for aborting as well so no further changes are needed. An oops can be reproduced with the new fw_fallback.sh fallback mechanism cancellation test. Either cancelling the fallback mechanism or the custom fallback mechanism triggers a crash. mcgrof@piggy ~/linux-next/tools/testing/selftests/firmware (git::20170111-fw-fixes)$ sudo ./fw_fallback.sh ./fw_fallback.sh: timeout works ./fw_fallback.sh: firmware comparison works ./fw_fallback.sh: fallback mechanism works [ this then sits here when it is trying the cancellation test ] Kernel log: test_firmware: loading 'nope-test-firmware.bin' misc test_firmware: Direct firmware load for nope-test-firmware.bin failed with error -2 misc test_firmware: Falling back to user helper BUG: unable to handle kernel NULL pointer dereference at 0000000000000038 IP: _request_firmware+0xa27/0xad0 PGD 0 Oops: 0000 [#1] SMP Modules linked in: test_firmware(E) ... etc ... CPU: 1 PID: 1396 Comm: fw_fallback.sh Tainted: G W E 4.10.0-rc3-next-20170111+ #30 Hardware name: QEMU Standard PC (i440FX + PIIX, 1996), BIOS rel-1.10.1-0-g8891697-prebuilt.qemu-project.org 04/01/2014 task: ffff9740b27f4340 task.stack: ffffbb15c0bc8000 RIP: 0010:_request_firmware+0xa27/0xad0 RSP: 0018:ffffbb15c0bcbd10 EFLAGS: 00010246 RAX: 00000000fffffffe RBX: ffff9740afe5aa80 RCX: 0000000000000000 RDX: ffff9740b27f4340 RSI: 0000000000000283 RDI: 0000000000000000 RBP: ffffbb15c0bcbd90 R08: ffffbb15c0bcbcd8 R09: 0000000000000000 R10: 0000000894a0d4b1 R11: 000000000000008c R12: ffffffffc0312480 R13: 0000000000000005 R14: ffff9740b1c32400 R15: 00000000000003e8 FS: 00007f8604422700(0000) GS:ffff9740bfc80000(0000) knlGS:0000000000000000 CS: 0010 DS: 0000 ES: 0000 CR0: 0000000080050033 CR2: 0000000000000038 CR3: 000000012164c000 CR4: 00000000000006e0 Call Trace: request_firmware+0x37/0x50 trigger_request_store+0x79/0xd0 [test_firmware] dev_attr_store+0x18/0x30 sysfs_kf_write+0x37/0x40 kernfs_fop_write+0x110/0x1a0 __vfs_write+0x37/0x160 ? _cond_resched+0x1a/0x50 vfs_write+0xb5/0x1a0 SyS_write+0x55/0xc0 ? trace_do_page_fault+0x37/0xd0 entry_SYSCALL_64_fastpath+0x1e/0xad RIP: 0033:0x7f8603f49620 RSP: 002b:00007fff6287b788 EFLAGS: 00000246 ORIG_RAX: 0000000000000001 RAX: ffffffffffffffda RBX: 000055c307b110a0 RCX: 00007f8603f49620 RDX: 0000000000000016 RSI: 000055c3084d8a90 RDI: 0000000000000001 RBP: 0000000000000016 R08: 000000000000c0ff R09: 000055c3084d6336 R10: 000055c307b108b0 R11: 0000000000000246 R12: 000055c307b13c80 R13: 000055c3084d6320 R14: 0000000000000000 R15: 00007fff6287b950 Code: 9f 64 84 e8 9c 61 fe ff b8 f4 ff ff ff e9 6b f9 ff ff 48 c7 c7 40 6b 8d 84 89 45 a8 e8 43 84 18 00 49 8b be 00 03 00 00 8b 45 a8 <83> 7f 38 02 74 08 e8 6e ec ff ff 8b 45 a8 49 c7 86 00 03 00 00 RIP: _request_firmware+0xa27/0xad0 RSP: ffffbb15c0bcbd10 CR2: 0000000000000038 ---[ end trace 6d94ac339c133e6f ]--- Fixes: 5d47ec02c37e ("firmware: Correct handling of fw_state_wait() return value") Reported-and-Tested-by: Jakub Kicinski <jakub.kicinski@netronome.com> Reported-and-Tested-by: Patrick Bruenn <p.bruenn@beckhoff.com> Reported-by: Chris Wilson <chris@chris-wilson.co.uk> CC: <stable@vger.kernel.org> [3.10+] Signed-off-by: Luis R. Rodriguez <mcgrof@kernel.org> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Diffstat (limited to 'sound/usb/pcm.c')