meta-gsj: quanta-nvme-powerctrl: Update package README document
Update design, process, test, todo subject included:
1. The new design follow PCI Express Card Electromechanical
Specification. It could review refer to specification section.
2. The new design and specification don't mention about SSD and LED
property so delete update led property and nvme_main property steps.
3. Update PCI clock function has been implemented so remove
TODO subject.
4. Improve initail power-up and service execute sequence.
5. Fix some grammer sentenses.
Change-Id: Ieef4e577b7e81e95ef95e961650de20736992ba6
Signed-off-by: Samuel Jiang <Samuel.Jiang@quantatw.com>
diff --git a/meta-gsj/recipes-gsj/quanta-nvme-powerctrl/README.md b/meta-gsj/recipes-gsj/quanta-nvme-powerctrl/README.md
index 51a9e8f..63b52d7 100644
--- a/meta-gsj/recipes-gsj/quanta-nvme-powerctrl/README.md
+++ b/meta-gsj/recipes-gsj/quanta-nvme-powerctrl/README.md
@@ -1,50 +1,46 @@
### NVME SSD Power Control Manager
#### Description
- The Package is Mantain for SSD power control and related noification handle Deamon
+ The package mantains for SSD power control and related noification handle Deamon
#### Design
- nvme_gpio.service for initinal related GPIOs ( PRESENT, PWR, PWRGD, RST_U2 ) and according PRESENT signal fix HW PWR default output signal.
- nvme_powermanager.service loop for monitor PRESENT signal and update PWR output.
+ The service power supply design follow PCI Express Card Electromechanical Specification Revision 3.0 in Section 2.2
+
+ nvme_gpio.service follow section 2.2.1 Initial power-Up to initinal and adjust related signal.
+
+ nvme_powermanager.service follow section 2.2.2 power management states monitor PRESENT signal and update related signal.
#### Process
- * Plugging
- 1. U2_[SSD_index]PRSNT_N will be input low
+ * Plugging
+ 1. U2_[SSD_index] PRSNT_N will be input low
2. Set PWR_U2_[SSD_index]_EN to high
3. Check PWRGD_U2_[SSD_index] is high
4-1. If PWRGD_U2_[SSD_index] is high (PWR Good)
- Wait 5ms
- Enable PCI Clock by SMBus 9FGL0851
- Wait 100ms
- - Reset RST_BMC_U2 [low->high]
- - Send Assert to tell package could read SSD status.
+ - Set RST_BMC_U2 to high
4-2. If PWRGD_U2_[SSD_index] is low (PWR Fail)
- - Disable Clock by SMBus
- - Wait 100ms
- Set RST_BMC_U2_[SSD_index]_R_N to low
- - Set LED_U2_FAULT to high
+ - Wait 100ms
+ - Disable PCI Clock by SMBus
* Removing
- 1. U2_[SSD_index]PRSNT_N will be input high
- 2. Disable Clock by SMBus 9FGL0851
- 3. PWR_U2_[SSD_index]_EN to low
- 4. Check PWRGD_U2_[SSD_index] is low
- 5. Send Assert to tell package update SSD status.
-
-
-#### TODO
-
- 1. After power on ssd, bmc send command to 9FGL0851 (on SMBus8 0x68) for enable PCI clock, and send RST_BMC_U2 pin rsing event (set low, wait 500ms, set high). The Host could rescan PCI and detect SSD device.
+ 1. U2_[SSD_index] PRSNT_N will be input high
+ 2. Set RST_BMC_U2 to low
+ 3. Wait 100ms
+ 4. Disable PCI Clock by SMBus
+ 5. Wait 5ms
+ 6. PWR_U2_[SSD_index]_EN to low
#### Test
- 1. PRESENT detect SSD: The Default Hardware is implement.
- 2. Initial SSD slot Power output: nvme_gpio service has test on Module. It could sucess initial gpios and setting correct power output.
- 3. Detect PRESENT and change power setting: nvme_powermanager service has tested on Module. It could success detect SSD plugged or removal change PWR output.
- 4. NVME-MI connect: Ensure SSD power is ready then it will notify quanta NVME-MI package could read SSD information.
- 5. FAULT LED handle: When detect power output irregular by PWRGD pin, the service will trigger related FAULT LED.
-
+ 1. PRESENT detect SSD: The hardware design has been implemented.
+ 2. Initial SSD slot Power output: nvme_gpio service has tested on Module. It could sucess initial gpios and set correct power output.
+ 3. Detect PRESENT and change power setting: nvme_powermanager service has tested on Module. It could success detect SSD plugged or removal change power output.
+ 4. Improve initial power-up sequence: For matched hardware default initial power-up setting, the nvme_gpio service only set unplugged slot related signal.
+ 5. Improve service execute sequence: nvme_powermanager.service must wait for nvme_gpio.service ensure gpio export complete.