dbroqua/kobol-wiki
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix typo, rearrange heading level and page name

Browse source
This commit is contained in:
Aditya Prayoga 2020-03-16 13:11:03 +07:00
parent eeeb8102a8
commit 03db643ed8
8 changed files with 70 additions and 68 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
docs/helios64/battery.md
View file

@ -1,20 +1,21 @@
## M2 Connector (P2)
There is at least two type of batteries which is installed in Helios64 board:
There are two types of batteries on Helios64 board:
- Li-Ion
- Coin-type Battery (CR 1225)
### Li-Ion Battery
## Li-Ion Battery
The Li-Ion battery is actually installed in to Helios64 caseing, but the battery is connected to the board in following connector:
The Li-Ion battery is actually installed in to Helios64 casing, but the battery is connected to the board in following connector:
![LBattery](/helios64/img/hardware/lbat.jpg)
The actual cell of the this Li-Ion battery is the panasonic NCR18650BD, we use 2 cell in serial configuration.
The actual cell of the this Li-Ion battery is the panasonic NCR18650BD, we use 2 cell in 2S1P configuration.
So the Li-Ion battery is rated at 2980mAh, 8.4Volt.
The time estimation to full charge this battery is 8.5 Hours.
The time estimation to fully charge this battery is 8.5 Hours.
#### Pinout of the BATT Header
### Pinout of the BATT Header
![LBattery](/helios64/img/hardware/batt-pinout.png)
@ -28,9 +29,9 @@ The time estimation to full charge this battery is 8.5 Hours.
| 6 |Battery -
### Coin Cell Battery
## Coin Cell Battery
The Location of coin-type battery is shown by this figure:
The Location of coin-type battery is shown by this figure:
![CBattery](/helios64/img/hardware/cbat.jpg)
The battery type is CR1225, this device has diameter of 12.5mm and 2.5mm thickness.
@ -38,11 +39,11 @@ In above figure the positive (+) polarity is heading downward to the CPU heatsin
This battery is used only for keep the RTC (Real Time Clock) running.
### Notes related to battery
## Notes related to battery
**To Be Confirmed**
We have NOT confirmed the operaiton of the RTC without CR1225 Coin Cell Battery, even in the situation with the Li-Ion connected we have NOT the operation of RTC.
!!! note
To be confirmed whether RTC is still running with Li-Ion battery only.
The Li-Ion battery design is not for powering device when the main AC supply is disconnected, but as the device support to perform graceful shutdown or hibernate.
Therfore if you found this device can actually turned on for a while when you push the power button, in the situation the Li-Ion battery is connected (when the main AC power disconnected), this is totally normal situation.
The Li-Ion battery is not designed to make Helios64 as portable device that can be used without AC power line, but designed as backup power to perform graceful shutdown or hibernate in case of loss of AC power line.
Therefore it is normal if Helios64 turned on for a while when you press power button without AC power line.

10
docs/helios64/front-panel.md
View file

@ -1,4 +1,4 @@
## Front Panel (P3)
## Front Panel Pinout
Helios64 provides 24 front panel pinout on header P3.
User can connect the front panel PCB into the P3 in the Helios64 board by using provided ribbon cable.
@ -10,8 +10,6 @@ Below Graphics and Table describe the layout of the front panel header.
This header are actually located at:
![P3 Location](/helios64/img/front-panel/fp-header-zoom.jpg)
### Front Panel Pinout Table
| PIN | Port | Remarks |
|-----|------|-------------|
| 1 | HDD LED - High Side (HS) | |
@ -39,7 +37,7 @@ This header are actually located at:
| 23 | SATA 4 Error - HS | |
| 24 | GND | Ground |
### Wiring Diagram
## Wiring Diagram
This Figures describe the PCB layout from the left hand side (RHS) and right hand side (LHS) view respectively.
The vertical mounting of this double-sided PCB will make the front panel have two LED indicators (red and green) for Sys and HDD 1 untill HDD 5 Activity Status(or Error Status).
@ -63,10 +61,10 @@ The connection between P3 from the Helios64 board to P1 on the front panel PCB b
### The Front Panel Description
## The Front Panel Description
Below graphics show the front panel descriptions:
![Front Panel Label](/helios64/img/front-panel/front-panel-labeled.jpg)
The USB 3.0 Cable are actually already mounted to the front panel PCB and the Helios64 Caseing, you only need to connect the usb male connector at the location illustrated in above figure.
The USB 3.0 Cable are actually already mounted to the front panel PCB and the Helios64 casing, you only need to connect the usb male connector at the location illustrated in above figure.

6
docs/helios64/gpio.md
View file

@ -1,11 +1,13 @@
## User Accessible GPIOs (P5)
Helios64 provides 22 GPIOs on header P5 which can be used for user application.
Those GPIOs are provided via an 16-bit IO Expander [PCA9655E](http://www.onsemi.com/PowerSolutions/product.do?id=PCA9655E) connected to I2C bus 0.
Those GPIOs are provided via an 16-bit IO Expander [PCA9655E](http://www.onsemi.com/PowerSolutions/product.do?id=PCA9655E) connected to I2C bus 2.
Unlike Helios4 whereas some pin of IO expander is used for system usage, on Helios64 all 16 GPIOs can be used for user application.
![P5 Pinout](/helios64/img/hardware/gpio.jpg)
### Pinout Table
## Pinout Table
| PIN | Port | Remarks |
|-----|------|-------------|

24
docs/helios64/i2c.md
View file

@ -1,4 +1,4 @@
### I2C Overview
## I2C Overview
Helios64 support I2C bus for the low-speed communication between devices like microcontrollers, EEPROMs, A/D and D/A converters, I/O interface and other similar peripherals in embedded systems.
In order to communicate with each I2C slave device you will need an address and communication scenario.
@ -17,7 +17,7 @@ Slave Address | R/W Bit | Description
111 11XX | X | Reserved for future purposes
### I2C bus on Helios64 / RK3399
## I2C bus on Helios64 / RK3399
The I2C controller on RK3399 support following features:
@ -29,7 +29,7 @@ The I2C controller on RK3399 support following features:
- Data on the I2C-bus can be transferred at rates of up to 100 kbit/s in the Standardmode, up to 400 kbit/s in the Fast-mode or up to 1 Mbit/s in Fast-mode Plus.
### Internal Bus (system reserved, NOT for user application)
## Internal Bus (system reserved, NOT for user application)
In the implementation, we divide the I2C controller into 2 category.
The first implementation is for system (internal bus) and the other one is for user application (external).
@ -62,7 +62,7 @@ Above bus number and also including bus number 1,3,5 are reserved for system use
!!! Warning
This bus number and address should not be accessed directly by user. Incorrect configuration can damaged the board!
### External Bus
## External Bus
Helios64 exposed Bus number 7 and 8 of the I2C in **P2** and **P1** pinout, respectively.
This I2C bus can be connected to the external devices.
@ -72,7 +72,7 @@ For the [UEXT](/helios64/img/hardware/UEXT_pinout.png) (pin header number *5* an
All the I2C bus in the board are using voltage level of 3.3V, please notice Helios64 is integrated with level translator and pull up resistor.
#### I2C at P1 Header
### I2C at P1 Header
Helios64 board exposes the SoC I2C Bus 1, on header **P1**. Below is the header pin-out.
@ -81,7 +81,7 @@ Helios64 board exposes the SoC I2C Bus 1, on header **P1**. Below is the header
This I2C device working with 3 pin bus (SDA, SCK, and GND), and also in band addressing.
We can use a 7 bit addressing to distinguish every device, but some address is reserved for the internal communication of the Helios64 board.
#### I2C at UEXT
### I2C at UEXT
The I2C header bus also can be found at UEXT connector (can be found at **P2** header at the the board [overview](/helios64/hardware/overview) page) on the header number 5 and 6.
Below is the detail description of the UEXT connector:
@ -101,9 +101,9 @@ Pin No | Description
9|SCK (SPI)
10|SSEL (SPI)
### Usage under Linux
## Usage under Linux
#### External bus block device under linux
### External bus block device under linux
Below table describe the external bus of I2C under Linux,
@ -113,7 +113,7 @@ Bus number | Device Block | Description |
8 | /dev/i2c-8 | |
#### Checking the I2C Communication under linux
### Checking the I2C Communication under linux
In order to communicate with the I2C devices, first we need to identify the I2C bus.
By performing scan you can see wether system detect the devices.
@ -142,9 +142,9 @@ root@helios64:~# i2cdetect -y 8
70: -- -- -- -- -- -- -- --
```
Here we can see there is a device detected at the address 0x3c. We can conclude is our OLED screen, unless you have connected more than just one I2C device on the **P1** header.
Here we can see there is a device detected at the address 0x3c. If you have connected more than just one I2C device on the **P1** header, there will be more device with different address detected on the bus.
#### Application example
### Application example
We have demonstrated the use of I2C bus of our board in the OLED application, as shown in the [I2C(OLED)](/helios4/i2c/) page you can communicate to the external device by using the external I2C bus.
We have demonstrated the use of I2C bus of our board in the OLED application, as shown in the [I2C(OLED)](/helios4/i2c/) page you can communicate to the external device by using the external I2C bus.

6
docs/helios64/led.md
View file

@ -4,7 +4,7 @@
The onboard LEDs location are shown in above figure
## LED indicators
### LED indicators
LED Name|Color|Description
---|---|---
@ -17,3 +17,7 @@ LED6|green|System Status
LED7|red|System Error
LED8|orange|Battery Charge
## Front Panel LEDs
Please refer to [Front Panel](/helios64/front-panel/#the-front-panel-description)

14
docs/helios64/m2.md
View file

@ -1,17 +1,17 @@
## M2 Connector (P2)
M.2, formerly known as the Next Generation Form Factor (NGFF), is a specification for internally mounted computer expansion cards and associated connectors. M.2 replaces the mSATA standard, which uses the PCI Express Mini Card physical card layout and connectors.
M.2, formerly known as the Next Generation Form Factor (NGFF), is a specification for internally mounted computer expansion cards and associated connectors.
M.2 replaces the mSATA standard, which uses the PCI Express Mini Card physical card layout and connectors.
Supported bus in the Helios64 M.2 interface is SATA and USB 2.0.
!!! Warning!
PCIe SSD is not supported.
!!! Warning
PCIe SSD is not supported.
---TBU---
## Location
Helios64 support M.2 device on header P2 which is located next to SATA 1 connector.
You can refer to the connector/interface list at [hardware overview](/helios64/hardware) page.
You can refer to the connector/interface list at [hardware overview](/helios64/hardware#connector-interface-list) page.
The location of the M.2 socket is shown in below figure:
![M2 Pinout](/helios64/img/m2/m2-zoom-w-symbol.jpg)
@ -25,6 +25,6 @@ The M.2 devices installed in Helios64 is configured as sharing devices with SATA
Therefore if you install M.2 SATA module, you will not be able to access the SATA Port 1.
In another case, if you use the M.2 USB module, the SATA Port 1 still accessible from the system.
The USB bus is connected to the EHCI Host 0.
The USB bus is connected to the [OHCI/EHCI Host 0](/helios64/usb/#usb-on-helios64).
The M.2 socket in the Helios64 board does NOT support the USB modem, because the USB modem require the SIM Card connection and another signal.
The M.2 socket in the Helios64 board may NOT support USB modem (WWAN), because the USB modem requires the SIM Card connection and another signal.

41
docs/helios64/uext.md
View file

@ -1,20 +1,15 @@
## UEXT Connector (P2)
### UEXT overview
## UEXT overview
the development boards so customer can choose which feature he want to use.
UEXT (Universal-Extension-Connector) is board to bard connector which support 3 serial communication interface, such as I2C, SPI, RS232.
UEXT (Universal-Extension-Connector) is board to board connector which support 3 serial communication interface, such as I2C, SPI, RS232.
The combination of theese feature is supported by every decent microcontroller, this will enable broad choice to connect modules.
UEXT gives you freedom to choose module that you want to use.
!!! Notice
As UEXT have RS232 and the Rx and Tx signals should be crossed we can say that UEXT on the board is with HOST; UEXT on the module is with SLAVE/DEVICE layout.
---TBU---
### Pinout Table
## Pinout Table
Helios64 provides UEXT on header P2 which following the UEXT standard, containing UEXT, SPI, and I2C connector.
You can find the P2 header from the connector/interface list at [hardware overview](/helios64/hardware) page.
@ -30,31 +25,30 @@ Below is the detailed description of UEXT header pinout:
| PIN | Port | Remarks |
|-----|------|-------------|
|1 |3.3V|
|2 |GND|
|3 |TXD (UART)|
|4 |RXD (UART)|
|5 |SCL (I2C)|
|6 |SDA (I2C)|
|7 |MISO (SPI)|
|8 |MOSI (SPI)|
|9 |SCK (SPI)|
|10 |SSEL (SPI)|
| 1 | 3.3V | |
| 2 | GND | |
| 3 | TXD (UART) | |
| 4 | RXD (UART) | |
| 5 | SCL (I2C) | |
| 6 | SDA (I2C) | |
| 7 | MISO (SPI) | |
| 8 | MOSI (SPI) | |
| 9 | SCK (SPI) | |
|10 | SSEL (SPI) | |
!!! Warning
Please note the UEXT connector at Helios64 board doesn't provide the plastic covering, so be carefull with the header polarity!
Make sure your device is correctly oriented before connecting!
### SPI and I2C
## SPI and I2C
The implementation of SPI and I2C in the UEXT connector is follow similar convention in the Helios64 board. Please reffer to this page:
The implementation of SPI and I2C in the UEXT connector is follow similar convention in the Helios64 board. Please refer to this page:
- [SPI](/helios64/hardware/)
- [I2C](/helios64/I2C/)
---**TBU**---
### Exception
## Exception
We have connected the UART bus from the RK3399 to the serial console in the USB-C, so there is no dedicated line of UART in the UEXT connector.
The UART bus in this UEXT header is the parallel ones with the serial console.
@ -62,3 +56,6 @@ Therefore if you connect some module which might ***require dedicated serial UAR
!!! Notes
Please note also, that GPS modules in UEXT format also will not work due to similar reason.
## References
https://www.olimex.com/Products/Modules/UEXT/

8
mkdocs.yml
View file

@ -77,14 +77,14 @@ nav:
- Hardware:
- Overview : 'helios64/hardware.md'
- Battery : 'helios64/battery.md'
- Front Panel : 'helios64/front-panel.md'
- GPIO : 'helios64/gpio.md'
- Front Panel (P3): 'helios64/front-panel.md'
- GPIO (P5): 'helios64/gpio.md'
- I2C : 'helios64/i2c.md'
- LED : 'helios64/led.md'
- M.2 : 'helios64/m2.md'
- M2 Connector (J2): 'helios64/m2.md'
- PWM Fan : 'helios64/fan.md'
- SPI : 'helios64/spi.md'
- UEXT : 'helios64/uext.md'
- UEXT Connector (P2): 'helios64/uext.md'
- USB : 'helios64/usb.md'
- Helios4:
- Introduction: 'helios4/intro.md'