Task List

The first place to look for open tasks that you can help with is the Issues List.

The following list will be removed once everything is moved to the Issues List, completed, or obsolete. If you are interested in helping with any of these tasks, coordinate with the person in parentheses. Try IRC first (freenode channel #hydrabus), then email. ###HydraFW v0.8 Work In Progress:

Generic:

• Updated ChibiOS from actual 3.0 to latest ChibiOS v16.1.4+/ChibiOS RT v4.0.0
  • Added benchmark tests see hydrafw command debug test-rx and python script https://github.com/bvernoux/hydrafw/blob/master/scripts/tx_bench.py
• Script support (Thanks to Baldanos) see commit 47f181a9
• Added SD script (to execute commands from sdcard file)
• Added SD startup script option (initscript file at root of sdcard)
• Fixed SDCard 4x slowness (was set implicitly to SDC_MODE_1BIT instead of SDC_MODE_4BIT in new chibios)
• Now Read speed on Class 10 MicroSD reach 11MBytes/s (using 24MHz - 4Bits SDIO mode, can be increased later to 48MHz - 4 bits SDIO on microSD supporting it)
• tokenline
  • Fixed issue on history with up key (Thanks to 0x8008135)
  • Manage invalid value for T_ARG_FLOAT & strict suffix only "k", "m" or "g" or no suffix for T_ARG_UINT & T_ARG_FLOAT
  • show_help() fix coverity scan bug "Dereferencing null pointer tl->parsed.last_token_entry"
• Updated drv/stm32cube to latest STM32Cube FW F4 V1.13.0
• HydraFW Coverity Scan defects fixed (Thanks to iceman1001)
• Add compatibility with python3 (always compatible with python 2.x) for dfu-convert.py & hydrafw-version.py (Thanks to Baldanos)

HydraBus specific:

• Console mode

  • Raw 3-wire (Thanks to Baldanos)
  • UART Bridge enhancement (Thanks to Baldanos)
    • The UART bridge now works perfectly at up to 115200 bauds
  • Measure frequency & Duty Cycle (from 1282Hz to 84MHz, 128Hz to 8.4Mhz too, autorange ...) (Thanks to Baldanos)
  • Hexdump in console command hd to display in hex / ascii data read for spi, i2c, uart, 2 and 3-wire (Thanks to Baldanos)

• Binary Mode

  • Raw 3-wire (Thanks to Baldanos)
    • Integrated in BBIO bbio_mode_rawwire which support now 2-wire and 3-wire
  • SPI binary mode Add configuration/selection of SPI1 or SPI2

HydraNFC specific:

• Add command sd (sdcard commands)

• Add Example bbio_hydranfc_init.py for HydraNFC init using Console mode + switch to bbIO mode for SPI2 Init & communication with TRF7970A (HydraNFC shield)

• Read / Display / Save Mifare Ultra Light tag data (64bytes raw data of the Tag)

  • read-mf-ul command now requires a mandatory filename as destination to save the Mifare Ultra Light 64bytes data to microsd file
  • See commit [d569fcd8] 27-May-2016 (https://github.com/bvernoux/hydrafw/commit/d569fcd853415d7d56e54ef773315abb45015285) (modified scan command)

• Emulate Mifare Ultra Light tag (Beta version does not work with phone) (7Bytes UID and 64bytes data support only READ command)

  • emul-mf-ul command add optional filename (same 64bytes raw file previously written to microsd by read-mf-ul)
  • See commit [d569fcd8] 27-May-2016 (https://github.com/bvernoux/hydrafw/commit/d569fcd853415d7d56e54ef773315abb45015285) (modified scan command)
  • This feature is a Beta version and will be rewritten using low level mode SDM TX/DM1 RX in order to be hard real-time & ISO compliant, which will also fix the emulation when using a Phone...

• NFC sniffer improvements and NFC sniffer command cleanup

  • Modified NFC RX Gain Reduction from 10dB to 5dB & use ISO14443A mode
    • The sniffer now use native ISO14443A mode instead of previous hybrid mode ISO14443B/A, those modifications (with NFC RX Gain reduction set to 5dB) give better sniffing sensitivity and bigger range to sniff PICC(NFC Tag) and PCD(NFC Reader)
  • Added sub command trace-uart1 to trace in realtime sniffed data to UART1 PA9 @8.4Mbauds 8N1 (validated with FTDI C232HM-DDHSL-0)
  • Moved sniff-dbg and sniff-raw command to sniff sub command debug and raw

  Note: It is not recommended to use sniff dbg or sniff raw with option trace-uart1 as there is too much data and realtime NFC acquisition/decoding is broken (because uart driver is synchronous/blocking until all data are transmitted) in future update the trace-uart1 feature will use a new UART DMA/asynchronous driver which will solve this problem in addition with the fact that the data will be not in ascii but binary.

• Clone Mifare Ultra Light tag (Work In Progress bvernoux)

  • clone-mf-ul command add optional filename (64bytes raw file written to microsd same as read-mf-ul)
    • Read Mifare Ultra Light card then Emulate it
    • Add optional filename to save Mifare Ultra Light tag data read (64bytes raw data of the Tag) to microSD

###HydraFW TODO/IDEA:

Generic:

• Add new utilities:

  • SPI for non intrusive sniffer for MISO/MOSI line (with support of /CS) => Already supported by Binary SPI mode
  • I2C for non intrusive sniffer for SDA line (with support of /CS)
  • Multimeter up to 3.3V/7.2MSPS(12bits) with logging in µSD file in real-time.

• Bootloader idea using official HydraBus (bootloader) OpenMoko USB ID:

  • USB DFU boot like implemented in actual firmware by keeping UBTN pressed during power ON.
  • Read a configuration file from SDcard(if present) and boot a custom firmware from SDcard(execution in SRAM).
  • other idea TBD.

• Protection/Debug features(for developer):

  • Implement basic stack overflow/underflow check with canaries between each stack (probably need chibios patch)
  • Implement advanced stack overflow/underflow protection using M4F MPU

To be checked depending on latest ChibiOS v16.1.4 or v16.2.0 USB CDC driver performances.

• Implement new USB stack(replace the one from chibios) based on STM32Cube USB Host/Device
  • Implement for USB1, USB Composite with:
    • USB CDC(for terminal)
    • Raw Bulk IN/OUT(used for binary mode)
  • Implement for USB2, USB Composite with:
    • USB CDC(for terminal)
    • Raw Bulk IN/OUT(used for binary mode)
    • Mass Storage (using microSD card)
  • Implement Ctrl-C Abort which work like UBTN press to stop waiting.
• Implement new SD card driver(replace the one from chibios) based on STM32Cube HAL
  • Implement detection & setting of high-speed microSD, in order to set frequency to 48MHz (instead of default 24MHz).
  • Check possibility to avoid IRQ and use DMA for microSD access in order to use microSD to read/write during real-time task (SPI/UART/I2C sniffer, read ADC, read GPIO, NFC sniffer/log...)
• Implemente Binary Mode (Raw Bulk IN/OUT):
  • In Host tools(Windows/Linux... using libusb) to communicate with binary mode SPI, I2C, UART.

HydraBus specific:

• I2C binary mode
  • I2C sniffer (TODO bbio_i2c_sniff code)
• BBIO_1WIRE code
• Use "SPI1", "UART2" etc instead of 1/2 when specifying device to use the same for "DAC1" & "DAC2"...
• Generate DAC output advanced mode using waveform and DMA to generate Sin, Square ...
  • Add Offset and Frequency parameter for waveforms.
• i2c:
  • Slave mode
  • Number of bits (7, 8, 10)
• spi:
  • Number of bits (any number)
• Waveform generator
• Measure time between two pin states using hardware timer
• New modes:
  • Parallel Bus (2 to 32bits) with mode sniffer, read and write (with option to log data in realtime to MicroSD) (depending on feedback)
  • 1 or 3 Wire with mode sniffer, read and write (depending on feedback)
  • Basic Scope up to 3.3V and up to 7.2MSPS/12bits
  • Nand Flash x8 and x16 support (see Nand support #12)
• USB 1.x/2.0 LS/FS sniffer mode (using special passthrough mode with logging directly to MicroSD) (see USB sniffer capability #21)

HydraNFC specific:

• Cleanup files trf7970a/src/trf797x.c & trf7970a/src/trf_spi.c and change license to Apache 2.0
• Refactor/Port code from TI NFCLink 1_0_0_3 RFID Files (.cpp/.h) BSD-3 License for TRF7970A driver (see trf7970a\src) (bvernoux)
  • Add also clean TRF7970A direct mode support (SDM/DM1 with Parity & CRC-A calculation)
    • See Issue HydraNFC add SDM TX/DM1 RX mode to implement custom Reader/Writer [Work In Progress] #43
• NFC Sniffer (ISO14443A/MIFARE) command for Wireshark with specific dissector (thanks to NicoHub)
• ISO14443A Emulation (TRF7970A hardware Anticol/UID) see new command emul-3a
  • More accurate emulation (it is too fast today and not compliant with ISO14443A ...)
• To be released see https://github.com/NicoHub/Wireshark-RFID-dissector for more details
• NFC:
  • Scan:
    • support 10-byte UIDs (If someone find Tags with 10 bytes UID)
    • implement real anti-collision (be able to detect 2 tags)
  • Sniffer:
    • real-time write in SD card to sniff during ultra long session (limited by SD card file size and not by the internal 64KB buffer)
    • add optional timestamp global and relative(between data) with at least 73.75ns resolution(for 13.56MHz)
    • Mode for ISO14443B and ISO15693 or lot of other mode TBD (raw specific mode)
  • Emulator mode (Card Emulation) is planned and lot of other modes TBD (like raw mode to modulate even proprietary protocol on 13.56MHz)
    • Emulation Tag Mifare One UID in Alpha (timings are not compliant, need more test...) is available https://github.com/bvernoux/hydrafw/blob/master/hydranfc/hydranfc_emul_mifare.c
    • Emulation Tag ISO14443A Tag UID in Alpha (need more test...) is available https://github.com/bvernoux/hydrafw/blob/master/hydranfc/hydranfc_emul_14443a_sdd.c
  • Read MIFARE tag:
    • Read MIFARE Classic 1K tag data ...

###Hardware Extension/Shield

• Extension using EEPROM:
  • Implement support of EEPROM extension detection with same hw & content as Beagle bone defined here

###Development Environment:

• Tutorial for EmBitz to load project and debug it (Windows only)
• Tutorial for Eclipse/ChibiStudio to load project and debug it (Windows only)
• Tutorial for Eclipse to load project and debug it (Linux)

###DONE (please test with HydraFW v0.7):

• CAN1 and CAN2 with HydraOBD Shield
• JTAG (with different MCU/CPU and report what work what do not work ...)
• 2-wire (I have tested mainly the write with different speed need to check the read ...)
• Logic Analyzer mode (to do more tests)
• Binary mode (to do more tests)