Skip to content

Commit

Permalink
Cart tester and refactor
Browse files Browse the repository at this point in the history
  • Loading branch information
@nopjne
nopjne committed Jul 24, 2023
1 parent 31a28ea commit 3c56ec5
Show file tree
Hide file tree
Showing 9 changed files with 377 additions and 243 deletions.
220 changes: 59 additions & 161 deletions README.rst
View file
Original file line number Diff line number Diff line change
@@ -1,162 +1,60 @@
.. figure:: docs/assets/logo.svg
:alt: TinyUSB

|Build Status| |Documentation Status| |Fuzzing Status| |License|

TinyUSB is an open-source cross-platform USB Host/Device stack for
embedded system, designed to be memory-safe with no dynamic allocation
and thread-safe with all interrupt events are deferred then handled in
the non-ISR task function.

Please take a look at the online `documentation <https://docs.tinyusb.org/>`__.

.. figure:: docs/assets/stack.svg
:width: 500px
:alt: stackup

::

.
├── docs # Documentation
├── examples # Sample with Makefile build support
├── hw
│ ├── bsp # Supported boards source files
│ └── mcu # Low level mcu core & peripheral drivers
├── lib # Sources from 3rd party such as freeRTOS, fatfs ...
├── src # All sources files for TinyUSB stack itself.
├── test # Unit tests for the stack
└── tools # Files used internally

Supported MCUs
==============

The stack supports the following MCUs:

- **Allwinner:** F1C100s/F1C200s
- **Broadcom:** BCM2837, BCM2711
- **Dialog:** DA1469x
- **Espressif:** ESP32-S2, ESP32-S3
- **GigaDevice:** GD32VF103
- **Infineon:** XMC4500
- **MicroChip:** SAMD11, SAMD21, SAMD51, SAME5x, SAMG55, SAML21, SAML22, SAME7x
- **NordicSemi:** nRF52833, nRF52840, nRF5340
- **Nuvoton:** NUC120, NUC121/NUC125, NUC126, NUC505
- **NXP:**

- iMX RT Series: RT10xx, RT11xx
- Kinetis: KL25, K32L2
- LPC Series: 11u, 13, 15, 17, 18, 40, 43, 51u, 54, 55

- **Raspberry Pi:** RP2040
- **Renesas:**

- RX Series: 63N, 65N, 72N
- RA Series: RA4M1, RA4M3

- **Silabs:** EFM32GG
- **Sony:** CXD56
- **ST:** STM32 series: F0, F1, F2, F3, F4, F7, H7, G0, G4, L0, L1, L4, L4+, WB
- **TI:** MSP430, MSP432E4, TM4C123
- **ValentyUSB:** eptri
- **WCH:** CH32V307

Here is the list of `Supported Devices`_ that can be used with provided examples.

Device Stack
============

Supports multiple device configurations by dynamically changing USB descriptors, low power functions such like suspend, resume, and remote wakeup. The following device classes are supported:

- Audio Class 2.0 (UAC2)
- Bluetooth Host Controller Interface (BTH HCI)
- Communication Device Class (CDC)
- Device Firmware Update (DFU): DFU mode (WIP) and Runtime
- Human Interface Device (HID): Generic (In & Out), Keyboard, Mouse, Gamepad etc ...
- Mass Storage Class (MSC): with multiple LUNs
- Musical Instrument Digital Interface (MIDI)
- Network with RNDIS, Ethernet Control Model (ECM), Network Control Model (NCM)
- Test and Measurement Class (USBTMC)
- Video class 1.5 (UVC): work in progress
- Vendor-specific class support with generic In & Out endpoints. Can be used with MS OS 2.0 compatible descriptor to load winUSB driver without INF file.
- `WebUSB <https://github.com/WICG/webusb>`__ with vendor-specific class

If you have a special requirement, `usbd_app_driver_get_cb()` can be used to write your own class driver without modifying the stack. Here is how the RPi team added their reset interface `raspberrypi/pico-sdk#197 <https://github.com/raspberrypi/pico-sdk/pull/197>`_

Host Stack
==========

- Human Interface Device (HID): Keyboard, Mouse, Generic
- Mass Storage Class (MSC)
- Hub with multiple-level support

TypeC PD Stack
==============

- Power Delivery 3.0 (PD3.0) with USB Type-C support (WIP)
- Super early stage, only for testing purpose
- Only support STM32 G4

OS Abstraction layer
====================

TinyUSB is completely thread-safe by pushing all Interrupt Service Request (ISR) events into a central queue, then processing them later in the non-ISR context task function. It also uses semaphore/mutex to access shared resources such as Communication Device Class (CDC) FIFO. Therefore the stack needs to use some of the OS's basic APIs. Following OSes are already supported out of the box.

- **No OS**
- **FreeRTOS**
- `RT-Thread <https://github.com/RT-Thread/rt-thread>`_: `repo <https://github.com/RT-Thread-packages/tinyusb>`_
- **Mynewt** Due to the newt package build system, Mynewt examples are better to be on its `own repo <https://github.com/hathach/mynewt-tinyusb-example>`_

Docs
====

- Info

- `Uses`_
- `Changelog`_
- `Contributors`_

- `Reference`_

- `Supported Devices`_
- `Getting Started`_
- `Dependencies`_
- `Concurrency`_

- `Contributing`_

- `Code of Conduct`_
- `Structure`_
- `Porting`_

License
=======

All TinyUSB sources in the ``src`` folder are licensed under MIT
license, the `Full license is here <LICENSE>`__. However, each file can be
individually licensed especially those in ``lib`` and ``hw/mcu`` folder.
Please make sure you understand all the license term for files you use
in your project.


.. |Build Status| image:: https://github.com/hathach/tinyusb/actions/workflows/cmake_arm.yml/badge.svg
:target: https://github.com/hathach/tinyusb/actions
.. |Documentation Status| image:: https://readthedocs.org/projects/tinyusb/badge/?version=latest
:target: https://docs.tinyusb.org/en/latest/?badge=latest
.. |Fuzzing Status| image:: https://oss-fuzz-build-logs.storage.googleapis.com/badges/tinyusb.svg
:target: https://oss-fuzz-build-logs.storage.googleapis.com/index.html#tinyusb
.. |License| image:: https://img.shields.io/badge/license-MIT-brightgreen.svg
:target: https://opensource.org/licenses/MIT


.. _Uses: docs/info/uses.rst
.. _Changelog: docs/info/changelog.rst
.. _Contributors: CONTRIBUTORS.rst
.. _Reference: docs/reference/index.rst
.. _Supported Devices: docs/reference/supported.rst
.. _Getting Started: docs/reference/getting_started.rst
.. _Dependencies: docs/reference/dependencies.rst
.. _Concurrency: docs/reference/concurrency.rst
.. _Contributing: docs/contributing/index.rst
.. _Code of Conduct: CODE_OF_CONDUCT.rst
.. _Structure: docs/contributing/structure.rst
.. _Porting: docs/contributing/porting.rst
DrmDmp64_mass is a mass storage device firmware for the DreamDumper64 project.
The DreamDumper64 uses a WeAct pico to read N64 caridges.
The DrmDump64_mass firmware is able to read up to 64MB, ROMs it also does its best to detect the actual rom size.
It also reads the save game chips, such as the SRAM (battery backed), SI EEPROM (most common) and FlashRAM (largests size).
All of these chips are exposed to the host PC as a file on a USB drive.

The DrmDmp64_mass also does cartridge verification, it will detect whether subsystems of the cartridge are present and/or working. \
```
"Cart tester report:"
" EEPROM - Not present"
" SRAM - OK!"
" FlashRam - OK!"
" CIC - PAL 6103"
" Romsize - 16MB"
" RomName - POKEMON SNAP"
" RomID - 504E PF"
" CartType - N"
" RomRegion - F"
" RomVersion - 00"
```

The following files are exposed from the virtual disk: \
```
D:\>dir /s
Volume in drive D is DreamDump64
Volume Serial Number is 0022-DC8F

Directory of D:\

09/05/2008 04:20 PM 512 ROM.EEP
09/05/2008 04:20 PM 131,072 ROM.FLA
09/05/2008 04:20 PM 12,582,912 ROM.N64
09/05/2008 04:20 PM 12,582,912 ROMF.Z64
09/05/2008 04:20 PM 131,072 ROMF.RAM
09/05/2008 04:20 PM 512 ROMF.EEP
09/05/2008 04:20 PM 2,048 CARTTEST.TXT
7 File(s) 25,431,040 bytes

ROM.EEP - Is either 512Byte or 2048Byte depending on 4K or 16K eeprom.
ROM.FLA - Is either the SRAM or FlashRAM, which is between 32KB or 128KB, the file is always exposed as 128KB for compatibility with the DaisyDrive64.
ROM.N64 - Is the N64 Native format of the ROM, this format is directly compatible with the DaisyDrive64.
ROMF.Z64 - This is the same data as ROM.N64 however 16bit byte flipped, for compatibility with PC emulators.
ROMF.RAM - Is the SRAM or FlashRAM data in byteflipped mode, for compatibility with PC emulators.
ROMF.EEP - Is the EEPROM data in byteflipped mode, for compatibility with PC emulators.
CARTTEST.TXT - Is the output of the cart tester during initialization.
```
How to use: \
```
1. Insert cartridge into the cartridge slot.
2. Connect USB to PC.
3. Navigate to the drive, use normally.
```
NOTE: When swapping cartridges make sure you disconnect and eject the drive, otherwise the operating system may cache the files from the previous cartridge.

Please look for PCBs here:
https://dreamcraftindustries.com/products/dreamdump64-pcb

Gerber files here:
https://github.com/khill25/Dreamdumper
2 changes: 1 addition & 1 deletion examples/device/cdc_msc/CMakeLists.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ add_custom_command(OUTPUT ${CMAKE_CURRENT_LIST_DIR}/src/generated/joybus.pio.h

target_sources(${PROJECT} PUBLIC
${CMAKE_CURRENT_SOURCE_DIR}/src/main.c
${CMAKE_CURRENT_SOURCE_DIR}/src/msc_disk.c
${CMAKE_CURRENT_SOURCE_DIR}/src/virtualdisk.c
${CMAKE_CURRENT_SOURCE_DIR}/src/usb_descriptors.c
${CMAKE_CURRENT_SOURCE_DIR}/src/n64cartinterface.c
${CMAKE_CURRENT_SOURCE_DIR}/src/joybus.c
Expand Down
4 changes: 2 additions & 2 deletions examples/device/cdc_msc/src/generated/joybus.pio.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ static const uint16_t joybus_program_instructions[] = {
0xf301, // 15: set pins, 1 [19]
0x0008, // 16: jmp 8
0xe081, // 17: set pindirs, 1
0xe601, // 18: set pins, 1 [6]
0xe600, // 19: set pins, 0 [6]
0xe501, // 18: set pins, 1 [5]
0xe500, // 19: set pins, 0 [5]
0x0012, // 20: jmp 18
// .wrap
};
Expand Down
88 changes: 51 additions & 37 deletions examples/device/cdc_msc/src/joybus.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ void __time_critical_func(InitEepromClock)(uint clockpin)
gpio_init(clockpin);
gpio_set_dir(clockpin, GPIO_OUT);

pio_gpio_init(pio_1, clockpin);

uint offset_1 = pio_add_program(pio_1, &joybus_program);
pio_sm_config config1 = joybus_program_get_default_config(offset_1);
//sm_config_set_out_pins(&config1, clockpin, 1);
Expand All @@ -64,19 +66,38 @@ void __time_critical_func(InitEepromClock)(uint clockpin)
pio_sm_set_enabled(pio_1, 1, true);
}

uint32_t GetInputWithTimeout(void)
{
uint32_t lastWriteTime = time_us_32();
while (1) {
if(pio_sm_is_rx_fifo_empty(pio, 0)) {
uint32_t now = time_us_32();
uint32_t diff = now - lastWriteTime;

// Send the eeprom data if it's been ?Seconds since the last eeprom write
// Reset the lastWriteTime to 0 and don't sent the data unless we get another write
if (lastWriteTime != 0 && diff > 100000) {
lastWriteTime = 0;
break;
}
} else {
return pio_sm_get(pio, 0);
}
}

return 0xFFFFFFFF;
}

pio_sm_config config;
void __time_critical_func(InitEeprom)(uint dataPin, uint clockpin)
void __time_critical_func(InitEeprom)(uint dataPin)
{
gpio_init(dataPin);
gpio_set_dir(dataPin, GPIO_IN);
gpio_pull_up(dataPin);

InitEepromClock(clockpin);

sleep_us(100); // Stabilize voltages

pio_gpio_init(pio, dataPin);
pio_gpio_init(pio_1, clockpin);

uint offset = pio_add_program(pio, &joybus_program);
config = joybus_program_get_default_config(offset);
Expand All @@ -86,47 +107,46 @@ void __time_critical_func(InitEeprom)(uint dataPin, uint clockpin)
sm_config_set_clkdiv(&config, 5);
sm_config_set_out_shift(&config, true, false, 32);
sm_config_set_in_shift(&config, false, true, 8);

pio_sm_init(pio, 0, offset, &config);
pio_sm_set_enabled(pio, 0, true);

// Send the info command
{
uint8_t probeResponse[1] = {0x00};
uint32_t result[2];
uint32_t result[8];
int resultLen;
convertToPio(probeResponse, 1, result, &resultLen);
sleep_us(6); // 3.75us into the bit before end bit => 6.25 to wait if the end-bit is 5us long

pio_sm_set_enabled(pio, 0, false);
pio_sm_init(pio, 0, offset+joybus_offset_outmode, &config);
pio_sm_init(pio, 0, offset + joybus_offset_outmode, &config);
pio_sm_set_enabled(pio, 0, true);

for (int i = 0; i < resultLen; i++) pio_sm_put_blocking(pio, 0, result[i]);
}

// Check response
uint32_t buffer[3];
sleep_us(35);
pio_sm_set_enabled(pio, 0, false);
pio_sm_init(pio, 0, offset + joybus_offset_inmode, &config);
pio_sm_set_enabled(pio, 0, true);
buffer[0] = pio_sm_get(pio, 0);
//buffer[0] = pio_sm_get_blocking(pio, 0);

// Determine the size of the EEPROM.
if (buffer[0] == 0x80) {
// 4K Eeprom.
ReadCount = 64;
gEepromSize = 512;
} else if (buffer[0] == 0xC0) {
// 16K Eeprom.
ReadCount = 256;
gEepromSize = 512 * 4;
} else {
// Unknown SI eeprom type.
ReadCount = 0;
gEepromSize = 0;
buffer[0] = GetInputWithTimeout();
if (buffer[0] == 0) {
buffer[1] = pio_sm_get_blocking(pio, 0);
buffer[2] = pio_sm_get_blocking(pio, 0);

// Determine the size of the EEPROM.
if (buffer[1] == 0x80) {
// 4K Eeprom.
ReadCount = 64;
gEepromSize = 512;
} else if (buffer[1] == 0xC0) {
// 16K Eeprom.
ReadCount = 256;
gEepromSize = 512 * 4;
} else {
// Unknown SI eeprom type.
ReadCount = 0;
gEepromSize = 0;
}
}
}

Expand All @@ -140,7 +160,7 @@ void __time_critical_func(ReadEepromData)(uint32_t offset, uint8_t *buffer)
for (uint32_t ReadIndex = 0; ReadIndex < 64; ReadIndex += 1) {
// Construct the read command.
uint8_t probeResponse[] = {0x04, (uint8_t)(ReadIndex + offset)};
uint32_t result[3];
uint32_t result[8];
int resultLen;
convertToPio(probeResponse, 1, result, &resultLen);
sleep_us(6); // 3.75us into the bit before end bit => 6.25 to wait if the end-bit is 5us long
Expand All @@ -153,11 +173,8 @@ void __time_critical_func(ReadEepromData)(uint32_t offset, uint8_t *buffer)
for (int i = 0; i < resultLen; i++) pio_sm_put_blocking(pio, 0, result[i]);

// Read the incoming data from the cart.
pio_sm_set_enabled(pio, 0, false);
pio_sm_init(pio, 0, offset + joybus_offset_inmode, &config);
pio_sm_set_enabled(pio, 0, true);
for (uint i = 0; i < 8; i += 1) {
buffer[i + ReadIndex] = (uint8_t)pio_sm_get_blocking(pio, 0);
for (int i = 0; i < resultLen; i += 1) {
buffer[(uint)i + (uint)ReadIndex] = (uint8_t)pio_sm_get_blocking(pio, 0);
}
}
}
Expand Down Expand Up @@ -186,9 +203,6 @@ void __time_critical_func(WriteEepromData)(uint32_t offset, uint8_t *buffer)

// Read the incoming data from the cart.
uint8_t response[2];
pio_sm_set_enabled(pio, 0, false);
pio_sm_init(pio, 0, offset + joybus_offset_inmode, &config);
pio_sm_set_enabled(pio, 0, true);
for (int i = 0; i < 2; i += 1) {
response[i] = (uint8_t)pio_sm_get_blocking(pio, 0);
}
Expand Down
Loading

0 comments on commit 3c56ec5

Please sign in to comment.