Difference between revisions of "PineFlash"

From PINE64
Jump to navigation Jump to search
(→‎Suggested Features: Punctuation)
(template fix)
 
(7 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Note|Page under construction, information subject to change.}}
{{under construction}}


The following is the documentation draft for a proposed new PINE64 storage product, PineFlash.  As such, PineFlash is proposed by the community and, as of April 2021, is '''neither endorsed nor acknowledged''' by PINE64 as a possible new official PINE64 product. This content is the result of initial discussions about this storage device, documented in [https://forum.pine64.org/showthread.php?tid=13301 this forum thread].
The following is the documentation draft for a proposed new PINE64 storage product, PineFlash.  As such, PineFlash is proposed by the community and, as of April 2021, is '''neither endorsed nor acknowledged''' by PINE64 as a possible new official PINE64 product. This content is the result of initial discussions about this storage device, documented in [https://forum.pine64.org/showthread.php?tid=13301 this forum thread].
Line 33: Line 33:
==== Hardware ====
==== Hardware ====


The initial idea is for the storage device to be in form of a "hat" for one of the BL602 devices manufactured and sold by PINE64, such as the [[Nutcracker]] board.
<s>The initial idea is for the storage device to be in form of a "hat" for one of the BL602 devices manufactured and sold by PINE64, such as the [[PineCone]] board.</s>
 
The initial idea for the base device was the [[PineCone]] board. Whist being a great device and RISC-V, we have since decided to move towards a better supported, more capable board.
 
We now look towards using the [https://www.pjrc.com/store/teensy41.html Teensy 4.1], which offers 480Mb/s USB throughput out of the box.


'''TO-DO:''' Plan out hardware steps.
'''TO-DO:''' Plan out hardware steps.
Line 49: Line 53:
=== Hardware ===
=== Hardware ===


The initial prototype is intended to be a "hat" for the community-driven [[Nutcracker]] project, based on the BL602 SoC. The CPU core is RISC-V (as the final controller is planned to be) and the SoC supports a quad-SPI flash interface.
As mentioned on the [https://www.pjrc.com/store/teensy41.html Teensy 4.1] website, it offers the following:
 
* ARM Cortex-M7 at 600 MHz
* Float point math unit, 64 & 32 bits
* 7936K Flash, 1024K RAM (512K tightly coupled), 4K EEPROM (emulated)
* QSPI memory expansion, locations for 2 extra RAM or Flash chips
* USB device 480 Mbit/sec & USB host 480 Mbit/sec
* 55 digital input/output pins, 35 PWM output pins
* 18 analog input pins
* 8 serial, 3 SPI, 3 I2C ports
* 2 I2S/TDM and 1 S/PDIF digital audio port
* 3 CAN Bus (1 with CAN FD)
* 1 SDIO (4 bit) native SD Card port
* Ethernet 10/100 Mbit with DP83825 PHY
* 32 general purpose DMA channels
* Cryptographic Acceleration & Random Number Generator
* RTC for date/time
* Programmable FlexIO
* Pixel Processing Pipeline
* Peripheral cross triggering
* Power On/Off management
 
Despite not appearing to have dedicated quad-SPI, it should be possible to make use of the ~55 digital pins to implement any protocol required.


==== Schematic ====
==== Schematic ====
Line 57: Line 83:
==== BOM ====
==== BOM ====


'''TO-DO:''' The bill of materials used in the schematic.
'''TO-DO:''' BOM based on Teensy 4.1 board.
 
* [https://nz.mouser.com/ProductDetail/Winbond/W25N512GWFIG?qs=T3oQrply3y%2Fc2oXtef14%252Bg%3D%3D 512Mb serial NAND] @ $3.23 ([https://nz.mouser.com/datasheet/2/949/w25n512gw_rev_c_011419-1608377.pdf Datasheet])
* [https://ww1.microchip.com/downloads/en/DeviceDoc/22288A.pdf USB-to-SPI converter]


==== PCB ====
==== PCB ====
Line 68: Line 91:
=== Software ===
=== Software ===


The work on the BL602 is to be on-top of the documented work by [https://lupyuen.github.io/articles/book Lupyuen].
For initial development it will be possible to use the Arduino IDE and eco-system to use existing libraries, extend functionality and test out initial ideas. It also provides a relatively fool-proof method for flashing new firmware to the device.


==== Libraries ====
==== Libraries ====
Line 84: Line 107:
This is a list of suggested features, collated and attributed (where possible). This list is not meant to encapsulate ''every'' possible idea or suggestion, just a series of plausible ones that can be considered within the scope of this project.
This is a list of suggested features, collated and attributed (where possible). This list is not meant to encapsulate ''every'' possible idea or suggestion, just a series of plausible ones that can be considered within the scope of this project.


* [https://forum.pine64.org/showthread.php?tid=13301&pid=90935#pid90935 Type A & Type C USB interfaces] ([https://forum.pine64.org/member.php?action=profile&uid=16880 barray])
* [https://forum.pine64.org/showthread.php?tid=13301&pid=90935#pid90935 Type-A & Type-C USB interfaces] ([https://forum.pine64.org/member.php?action=profile&uid=16880 barray])
* [https://forum.pine64.org/showthread.php?tid=13301&pid=90935#pid90935 RAID] ([https://forum.pine64.org/member.php?action=profile&uid=16880 barray])
* [https://forum.pine64.org/showthread.php?tid=13301&pid=90935#pid90935 RAID] ([https://forum.pine64.org/member.php?action=profile&uid=16880 barray])
* [https://forum.pine64.org/showthread.php?tid=13301&pid=91066#pid91066 Dynamically adjusted wear leveling pool] ([https://forum.pine64.org/member.php?action=profile&uid=7999 Arwen])
* [https://forum.pine64.org/showthread.php?tid=13301&pid=91066#pid91066 Dynamically adjusted wear leveling pool] ([https://forum.pine64.org/member.php?action=profile&uid=7999 Arwen])
* [https://forum.pine64.org/showthread.php?tid=13301&pid=91066#pid91066 USB attached SCSI, (aka UASP)] ([https://forum.pine64.org/member.php?action=profile&uid=7999 Arwen])
* [https://forum.pine64.org/showthread.php?tid=13301&pid=92518#pid92518 Keep 2 copies of the wear leveling & indirect table, with checksum, to avoid corruption] ([https://forum.pine64.org/member.php?action=profile&uid=7999 Arwen])
* [https://forum.pine64.org/showthread.php?tid=13301&pid=91066#pid91066 USB Attached SCSI (UASP)] ([https://forum.pine64.org/member.php?action=profile&uid=7999 Arwen])
* [https://forum.pine64.org/showthread.php?tid=13301&pid=91066#pid91066 SMART (probably requires UASP first)] ([https://forum.pine64.org/member.php?action=profile&uid=7999 Arwen])
* [https://forum.pine64.org/showthread.php?tid=13301&pid=92698#pid92698 Ability to define and enforce write barriers] ([https://forum.pine64.org/member.php?action=profile&uid=18910 dsimic])
* [https://forum.pine64.org/showthread.php?tid=13301&pid=91118#pid91118 Fingerprint scanner] ([https://forum.pine64.org/member.php?action=profile&uid=20753 Julius_GU])
* [https://forum.pine64.org/showthread.php?tid=13301&pid=91118#pid91118 Fingerprint scanner] ([https://forum.pine64.org/member.php?action=profile&uid=20753 Julius_GU])
* [https://forum.pine64.org/showthread.php?tid=13301&pid=91122#pid91122 Lit Pine logo on casing] ([https://forum.pine64.org/member.php?action=profile&uid=20753 Julius_GU])
* [https://forum.pine64.org/showthread.php?tid=13301&pid=91122#pid91122 Lit Pine logo on casing] ([https://forum.pine64.org/member.php?action=profile&uid=20753 Julius_GU])

Latest revision as of 16:01, 4 September 2021

This page is under construction

Please help to review and edit this page or paragraph. Information are subject to change.

The following is the documentation draft for a proposed new PINE64 storage product, PineFlash. As such, PineFlash is proposed by the community and, as of April 2021, is neither endorsed nor acknowledged by PINE64 as a possible new official PINE64 product. This content is the result of initial discussions about this storage device, documented in this forum thread.

Please, consider joining us for discussion in IRC.

Goal

The aim of this project is to create an open-hardware USB flash drive, hence the name PineFlash, which can act as the basis of future projects in the area of open storage. An open-hardware flash device with open-source firmware would allow the community to address storage safety and information security. Additionally, issues such as speed, functionality and compatibility could also be addressed.

Requirements

Property Minimum Ideal
Read speed 12 Mbit/s (Full-Speed USB 1.x) 480 Mbit/s (High-Speed USB 2.0)
Write speed 12 Mbit/s (Full-Speed USB 1.x) 480 Mbit/s (High-Speed USB 2.0)

Road Map

This is intended to document the project direction towards a manufacturing-viable device.

Prototype

Hardware

The initial idea is for the storage device to be in form of a "hat" for one of the BL602 devices manufactured and sold by PINE64, such as the PineCone board.

The initial idea for the base device was the PineCone board. Whist being a great device and RISC-V, we have since decided to move towards a better supported, more capable board.

We now look towards using the Teensy 4.1, which offers 480Mb/s USB throughput out of the box.

TO-DO: Plan out hardware steps.

Software

  1. USB 1.x speed mass storage device, no real storage. Get the controller presenting itself as a mass storage device. Data read and written will just be placeholder data to prove that the USB communication is working correctly.
  2. Single flash chip selected for storage - quad-SPI. Prove out that we can select a single flash chip, store data to it and read it back. This proves our understanding of the quad-SPI interface and implement some basic interface for communicating with a single flash chip.
  3. Multiple flash chips selected for storage - quad-SPI. Prove that we can communicate with multiple flash chips via quad-SPI.

Prototyping

This is the documentation of the initial prototype design.

Hardware

As mentioned on the Teensy 4.1 website, it offers the following:

  • ARM Cortex-M7 at 600 MHz
  • Float point math unit, 64 & 32 bits
  • 7936K Flash, 1024K RAM (512K tightly coupled), 4K EEPROM (emulated)
  • QSPI memory expansion, locations for 2 extra RAM or Flash chips
  • USB device 480 Mbit/sec & USB host 480 Mbit/sec
  • 55 digital input/output pins, 35 PWM output pins
  • 18 analog input pins
  • 8 serial, 3 SPI, 3 I2C ports
  • 2 I2S/TDM and 1 S/PDIF digital audio port
  • 3 CAN Bus (1 with CAN FD)
  • 1 SDIO (4 bit) native SD Card port
  • Ethernet 10/100 Mbit with DP83825 PHY
  • 32 general purpose DMA channels
  • Cryptographic Acceleration & Random Number Generator
  • RTC for date/time
  • Programmable FlexIO
  • Pixel Processing Pipeline
  • Peripheral cross triggering
  • Power On/Off management

Despite not appearing to have dedicated quad-SPI, it should be possible to make use of the ~55 digital pins to implement any protocol required.

Schematic

TO-DO: The proposed schematic for the device.

BOM

TO-DO: BOM based on Teensy 4.1 board.

PCB

TO-DO: The PCB design for the device.

Software

For initial development it will be possible to use the Arduino IDE and eco-system to use existing libraries, extend functionality and test out initial ideas. It also provides a relatively fool-proof method for flashing new firmware to the device.

Libraries

TO-DO: Document the prototype's software stack.

  • TinyUSB - An open source software stack for slave USB devices

Testing

TO-DO: Figure out exactly how the prototype will be tested to ensure robustness and performance.

Suggested Features

This is a list of suggested features, collated and attributed (where possible). This list is not meant to encapsulate every possible idea or suggestion, just a series of plausible ones that can be considered within the scope of this project.

Additional Resources