1104a010fSPaul Zimmerman /* 2104a010fSPaul Zimmerman * dwc-hsotg (dwc2) USB host controller state definitions 3104a010fSPaul Zimmerman * 4104a010fSPaul Zimmerman * Based on hw/usb/hcd-ehci.h 5104a010fSPaul Zimmerman * 6104a010fSPaul Zimmerman * Copyright (c) 2020 Paul Zimmerman <pauldzim@gmail.com> 7104a010fSPaul Zimmerman * 8104a010fSPaul Zimmerman * This program is free software; you can redistribute it and/or modify 9104a010fSPaul Zimmerman * it under the terms of the GNU General Public License as published by 10104a010fSPaul Zimmerman * the Free Software Foundation; either version 2 of the License, or 11104a010fSPaul Zimmerman * (at your option) any later version. 12104a010fSPaul Zimmerman * 13104a010fSPaul Zimmerman * This program is distributed in the hope that it will be useful, 14104a010fSPaul Zimmerman * but WITHOUT ANY WARRANTY; without even the implied warranty of 15104a010fSPaul Zimmerman * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16104a010fSPaul Zimmerman * GNU General Public License for more details. 17104a010fSPaul Zimmerman */ 18104a010fSPaul Zimmerman 19104a010fSPaul Zimmerman #ifndef HW_USB_DWC2_H 20104a010fSPaul Zimmerman #define HW_USB_DWC2_H 21104a010fSPaul Zimmerman 22104a010fSPaul Zimmerman #include "qemu/timer.h" 23104a010fSPaul Zimmerman #include "hw/irq.h" 24104a010fSPaul Zimmerman #include "hw/sysbus.h" 25104a010fSPaul Zimmerman #include "hw/usb.h" 26104a010fSPaul Zimmerman #include "sysemu/dma.h" 27*db1015e9SEduardo Habkost #include "qom/object.h" 28104a010fSPaul Zimmerman 29104a010fSPaul Zimmerman #define DWC2_MMIO_SIZE 0x11000 30104a010fSPaul Zimmerman 31104a010fSPaul Zimmerman #define DWC2_NB_CHAN 8 /* Number of host channels */ 32104a010fSPaul Zimmerman #define DWC2_MAX_XFER_SIZE 65536 /* Max transfer size expected in HCTSIZ */ 33104a010fSPaul Zimmerman 34104a010fSPaul Zimmerman typedef struct DWC2Packet DWC2Packet; 35104a010fSPaul Zimmerman typedef struct DWC2State DWC2State; 36104a010fSPaul Zimmerman typedef struct DWC2Class DWC2Class; 37104a010fSPaul Zimmerman 38104a010fSPaul Zimmerman enum async_state { 39104a010fSPaul Zimmerman DWC2_ASYNC_NONE = 0, 40104a010fSPaul Zimmerman DWC2_ASYNC_INITIALIZED, 41104a010fSPaul Zimmerman DWC2_ASYNC_INFLIGHT, 42104a010fSPaul Zimmerman DWC2_ASYNC_FINISHED, 43104a010fSPaul Zimmerman }; 44104a010fSPaul Zimmerman 45104a010fSPaul Zimmerman struct DWC2Packet { 46104a010fSPaul Zimmerman USBPacket packet; 47104a010fSPaul Zimmerman uint32_t devadr; 48104a010fSPaul Zimmerman uint32_t epnum; 49104a010fSPaul Zimmerman uint32_t epdir; 50104a010fSPaul Zimmerman uint32_t mps; 51104a010fSPaul Zimmerman uint32_t pid; 52104a010fSPaul Zimmerman uint32_t index; 53104a010fSPaul Zimmerman uint32_t pcnt; 54104a010fSPaul Zimmerman uint32_t len; 55104a010fSPaul Zimmerman int32_t async; 56104a010fSPaul Zimmerman bool small; 57104a010fSPaul Zimmerman bool needs_service; 58104a010fSPaul Zimmerman }; 59104a010fSPaul Zimmerman 60104a010fSPaul Zimmerman struct DWC2State { 61104a010fSPaul Zimmerman /*< private >*/ 62104a010fSPaul Zimmerman SysBusDevice parent_obj; 63104a010fSPaul Zimmerman 64104a010fSPaul Zimmerman /*< public >*/ 65104a010fSPaul Zimmerman USBBus bus; 66104a010fSPaul Zimmerman qemu_irq irq; 67104a010fSPaul Zimmerman MemoryRegion *dma_mr; 68104a010fSPaul Zimmerman AddressSpace dma_as; 69104a010fSPaul Zimmerman MemoryRegion container; 70104a010fSPaul Zimmerman MemoryRegion hsotg; 71104a010fSPaul Zimmerman MemoryRegion fifos; 72104a010fSPaul Zimmerman 73104a010fSPaul Zimmerman union { 74104a010fSPaul Zimmerman #define DWC2_GLBREG_SIZE 0x70 75104a010fSPaul Zimmerman uint32_t glbreg[DWC2_GLBREG_SIZE / sizeof(uint32_t)]; 76104a010fSPaul Zimmerman struct { 77104a010fSPaul Zimmerman uint32_t gotgctl; /* 00 */ 78104a010fSPaul Zimmerman uint32_t gotgint; /* 04 */ 79104a010fSPaul Zimmerman uint32_t gahbcfg; /* 08 */ 80104a010fSPaul Zimmerman uint32_t gusbcfg; /* 0c */ 81104a010fSPaul Zimmerman uint32_t grstctl; /* 10 */ 82104a010fSPaul Zimmerman uint32_t gintsts; /* 14 */ 83104a010fSPaul Zimmerman uint32_t gintmsk; /* 18 */ 84104a010fSPaul Zimmerman uint32_t grxstsr; /* 1c */ 85104a010fSPaul Zimmerman uint32_t grxstsp; /* 20 */ 86104a010fSPaul Zimmerman uint32_t grxfsiz; /* 24 */ 87104a010fSPaul Zimmerman uint32_t gnptxfsiz; /* 28 */ 88104a010fSPaul Zimmerman uint32_t gnptxsts; /* 2c */ 89104a010fSPaul Zimmerman uint32_t gi2cctl; /* 30 */ 90104a010fSPaul Zimmerman uint32_t gpvndctl; /* 34 */ 91104a010fSPaul Zimmerman uint32_t ggpio; /* 38 */ 92104a010fSPaul Zimmerman uint32_t guid; /* 3c */ 93104a010fSPaul Zimmerman uint32_t gsnpsid; /* 40 */ 94104a010fSPaul Zimmerman uint32_t ghwcfg1; /* 44 */ 95104a010fSPaul Zimmerman uint32_t ghwcfg2; /* 48 */ 96104a010fSPaul Zimmerman uint32_t ghwcfg3; /* 4c */ 97104a010fSPaul Zimmerman uint32_t ghwcfg4; /* 50 */ 98104a010fSPaul Zimmerman uint32_t glpmcfg; /* 54 */ 99104a010fSPaul Zimmerman uint32_t gpwrdn; /* 58 */ 100104a010fSPaul Zimmerman uint32_t gdfifocfg; /* 5c */ 101104a010fSPaul Zimmerman uint32_t gadpctl; /* 60 */ 102104a010fSPaul Zimmerman uint32_t grefclk; /* 64 */ 103104a010fSPaul Zimmerman uint32_t gintmsk2; /* 68 */ 104104a010fSPaul Zimmerman uint32_t gintsts2; /* 6c */ 105104a010fSPaul Zimmerman }; 106104a010fSPaul Zimmerman }; 107104a010fSPaul Zimmerman 108104a010fSPaul Zimmerman union { 109104a010fSPaul Zimmerman #define DWC2_FSZREG_SIZE 0x04 110104a010fSPaul Zimmerman uint32_t fszreg[DWC2_FSZREG_SIZE / sizeof(uint32_t)]; 111104a010fSPaul Zimmerman struct { 112104a010fSPaul Zimmerman uint32_t hptxfsiz; /* 100 */ 113104a010fSPaul Zimmerman }; 114104a010fSPaul Zimmerman }; 115104a010fSPaul Zimmerman 116104a010fSPaul Zimmerman union { 117104a010fSPaul Zimmerman #define DWC2_HREG0_SIZE 0x44 118104a010fSPaul Zimmerman uint32_t hreg0[DWC2_HREG0_SIZE / sizeof(uint32_t)]; 119104a010fSPaul Zimmerman struct { 120104a010fSPaul Zimmerman uint32_t hcfg; /* 400 */ 121104a010fSPaul Zimmerman uint32_t hfir; /* 404 */ 122104a010fSPaul Zimmerman uint32_t hfnum; /* 408 */ 123104a010fSPaul Zimmerman uint32_t rsvd0; /* 40c */ 124104a010fSPaul Zimmerman uint32_t hptxsts; /* 410 */ 125104a010fSPaul Zimmerman uint32_t haint; /* 414 */ 126104a010fSPaul Zimmerman uint32_t haintmsk; /* 418 */ 127104a010fSPaul Zimmerman uint32_t hflbaddr; /* 41c */ 128104a010fSPaul Zimmerman uint32_t rsvd1[8]; /* 420-43c */ 129104a010fSPaul Zimmerman uint32_t hprt0; /* 440 */ 130104a010fSPaul Zimmerman }; 131104a010fSPaul Zimmerman }; 132104a010fSPaul Zimmerman 133104a010fSPaul Zimmerman #define DWC2_HREG1_SIZE (0x20 * DWC2_NB_CHAN) 134104a010fSPaul Zimmerman uint32_t hreg1[DWC2_HREG1_SIZE / sizeof(uint32_t)]; 135104a010fSPaul Zimmerman 136104a010fSPaul Zimmerman #define hcchar(_ch) hreg1[((_ch) << 3) + 0] /* 500, 520, ... */ 137104a010fSPaul Zimmerman #define hcsplt(_ch) hreg1[((_ch) << 3) + 1] /* 504, 524, ... */ 138104a010fSPaul Zimmerman #define hcint(_ch) hreg1[((_ch) << 3) + 2] /* 508, 528, ... */ 139104a010fSPaul Zimmerman #define hcintmsk(_ch) hreg1[((_ch) << 3) + 3] /* 50c, 52c, ... */ 140104a010fSPaul Zimmerman #define hctsiz(_ch) hreg1[((_ch) << 3) + 4] /* 510, 530, ... */ 141104a010fSPaul Zimmerman #define hcdma(_ch) hreg1[((_ch) << 3) + 5] /* 514, 534, ... */ 142104a010fSPaul Zimmerman #define hcdmab(_ch) hreg1[((_ch) << 3) + 7] /* 51c, 53c, ... */ 143104a010fSPaul Zimmerman 144104a010fSPaul Zimmerman union { 145104a010fSPaul Zimmerman #define DWC2_PCGREG_SIZE 0x08 146104a010fSPaul Zimmerman uint32_t pcgreg[DWC2_PCGREG_SIZE / sizeof(uint32_t)]; 147104a010fSPaul Zimmerman struct { 148104a010fSPaul Zimmerman uint32_t pcgctl; /* e00 */ 149104a010fSPaul Zimmerman uint32_t pcgcctl1; /* e04 */ 150104a010fSPaul Zimmerman }; 151104a010fSPaul Zimmerman }; 152104a010fSPaul Zimmerman 153104a010fSPaul Zimmerman /* TODO - implement FIFO registers for slave mode */ 154104a010fSPaul Zimmerman #define DWC2_HFIFO_SIZE (0x1000 * DWC2_NB_CHAN) 155104a010fSPaul Zimmerman 156104a010fSPaul Zimmerman /* 157104a010fSPaul Zimmerman * Internal state 158104a010fSPaul Zimmerman */ 159104a010fSPaul Zimmerman QEMUTimer *eof_timer; 160104a010fSPaul Zimmerman QEMUTimer *frame_timer; 161104a010fSPaul Zimmerman QEMUBH *async_bh; 162104a010fSPaul Zimmerman int64_t sof_time; 163104a010fSPaul Zimmerman int64_t usb_frame_time; 164104a010fSPaul Zimmerman int64_t usb_bit_time; 165104a010fSPaul Zimmerman uint32_t usb_version; 166104a010fSPaul Zimmerman uint16_t frame_number; 167104a010fSPaul Zimmerman uint16_t fi; 168104a010fSPaul Zimmerman uint16_t next_chan; 169104a010fSPaul Zimmerman bool working; 170104a010fSPaul Zimmerman USBPort uport; 171104a010fSPaul Zimmerman DWC2Packet packet[DWC2_NB_CHAN]; /* one packet per chan */ 172104a010fSPaul Zimmerman uint8_t usb_buf[DWC2_NB_CHAN][DWC2_MAX_XFER_SIZE]; /* one buffer per chan */ 173104a010fSPaul Zimmerman }; 174104a010fSPaul Zimmerman 175104a010fSPaul Zimmerman struct DWC2Class { 176104a010fSPaul Zimmerman /*< private >*/ 177104a010fSPaul Zimmerman SysBusDeviceClass parent_class; 178104a010fSPaul Zimmerman ResettablePhases parent_phases; 179104a010fSPaul Zimmerman 180104a010fSPaul Zimmerman /*< public >*/ 181104a010fSPaul Zimmerman }; 182104a010fSPaul Zimmerman 183104a010fSPaul Zimmerman #define TYPE_DWC2_USB "dwc2-usb" 184104a010fSPaul Zimmerman #define DWC2_USB(obj) \ 185104a010fSPaul Zimmerman OBJECT_CHECK(DWC2State, (obj), TYPE_DWC2_USB) 18679f6cf7eSEduardo Habkost #define DWC2_USB_CLASS(klass) \ 187104a010fSPaul Zimmerman OBJECT_CLASS_CHECK(DWC2Class, (klass), TYPE_DWC2_USB) 18879f6cf7eSEduardo Habkost #define DWC2_USB_GET_CLASS(obj) \ 189104a010fSPaul Zimmerman OBJECT_GET_CLASS(DWC2Class, (obj), TYPE_DWC2_USB) 190104a010fSPaul Zimmerman 191104a010fSPaul Zimmerman #endif 192