NVMe-IP by AB17 Demo Instruction Rev1.0 4-May-18

Transcription

1 NVMe-IP by AB17 Demo Instruction Rev1.0 4-May-18 This document describes the instruction to run NVMe-IP demo on FPGA development board by using AB17-M2FMC board. The demo is designed to write/verify data with M.2 NVMe SSD. User controls test operation through Serial console. 1 Environment Requirement To run the demo on FPGA development board, please prepare following environment. 1) FPGA Development board: KCU105/VCU118 2) PC installing Xilinx programmer software (Vivado) and Serial console software such as HyperTerminal 3) AB17-M2FMC board, provided by Design Gateway 4) Xilinx Power adapter for FPGA board 5) M.2 NVMe SSD, inserting to Drive#1 M.2 connector on AB17 6) Two micro USB cables for programming FPGA and Serial console, connecting between FPGA board and PC Figure 1-1 NVMe-IP demo by AB17 setup on KCU105 4-May-18 Page 1

2 Figure 1-2 NVMe-IP demo by AB17 setup on VCU118 4-May-18 Page 2

3 2 Demo setup 1) Power off system. 2) Connect M.2 NVMe SSD to Drive#1 M.2 connector on AB17-M2FMC, as shown in Figure 2-1. Figure 2-1 Connect M.2 NVMe to AB17 3) Connect AB17-M2FMC to HPC connector (J22) for KCU105 or HSPC connector (J22) for VCU118, as shown in Figure 2-2. Figure 2-2 Connect AB17 to FPGA board 4-May-18 Page 3

4 4) Connect two micro USB cables between FPGA board and PC for FPGA programming and Serial console. Figure 2-3 USB cable connection 5) Turn on power switch on AB17-M2FMC and FPGA development board, as shown in Figure 2-4. Figure 2-4 Turn on power switch 4-May-18 Page 4

5 6) On PC, there are two additional COM ports from FPGA connection, as shown in Figure 2-5. Open Serial console program such as TeraTerm, HyperTerminal to connect with Standard COM port for running NVMe-IP demo. On Serial console, set Buad rate=115,200 Data=8 bit Non-Parity Stop=1. For KCU105, another Serial console is also opened to connect with Enhanced COM port for setting VADJ voltage through System controller menu. Figure 2-5 Two COM ports from FPGA connection 4-May-18 Page 5

6 7) Set VADJ of FMC. a) For KCU105 board, open Serial console to connect with Enhanced COM port (Buad rate=115,200 Data=8 bit Non-Parity Stop=1). The console shows System Controller menu, as shown in Figure 2-6. To set VADJ of FMC to 1.8V, the following step is recommended. (1) Input 4 to select Adjust FMC Settings. (2) Input 4 to set FMC VADJ to 1.8V. (3) Input 0 to return to Main Menu. (4) Input 2 to get PMBUS Voltages. (5) Input 7 to get VADJ1V8 Voltage. The output voltage of this menu must be equal to 1.8V to confirm that VADJ has been set completely. For more details of System Controller, please check UG917 KCU105 Board User Guide in section Appendix C: System Controller. u105-eval-bd.pdf Figure 2-6 Setting VADJ of FMC for KCU105 4-May-18 Page 6

7 b) For VCU118 board, it needs to download System controller tool (SCUI.exe) for setting VADJ from Xilinx website. Direct link for Vivado version to download the tool is as follows. 6-bc89-402c be69db6f96c&filename=rdf0396-vcu118-system-controller-c zip To set VADJ of FMC to 1.8V, open SCUI.exe and run following step. (1) Select File->Change the System Controller Port. (2) Select COM port number which is Enhanced COM Port. (3) Click OK button to confirm the port. (4) Select FMC tab -> Set VADJ tab -> Current tab. Click Set VADJ to 1.8V button. (5) Select Voltages tab and click Get VADJ_1V8 Voltage button. The output voltage must be equal to 1.8V to confirm that VADJ has been set completely. Figure 2-7 Setting VADJ of FMC for VCU118 4-May-18 Page 7

8 8) Use Vivado tool to download configuration file, as shown in Figure 2-8. Figure 2-8 Programmed by Vivado 9) Check LED status on FPGA board. The description of LED is as follows. GPIO LED ON OFF 0 Normal operation SSD is not good status or reset button is pressed 1 System is busy Idle status 2 IP Error detect Normal operation 3 Data verification fail Normal operation Table 2-1 LED Definition 4-May-18 Page 8

9 10) After programming completely, LED[0] and LED[1] are ON during PCIe initialization process. Then, LED[1] changes to OFF after PCIe completes initialization process and system is ready to receive command from user. After that, main menu is displayed, as shown in Figure Figure 2-9 LED status after program configuration file and PCIe initialization complete Figure 2-10 Main menu after program configuration file and PCIe initialization complete 4-May-18 Page 9

10 3 Test Menu 3.1 Identify Command Select 0 to send Identify command to NVMe SSD. When operation is completed, SSD information is displayed on the console, i.e. 1) SSD model number 2) SSD capacity which is output from NVMe-IP. Figure 3-1 Result from Identify Device menu 4-May-18 Page 10

11 3.2 Write Command Select 1 to send Write command to NVMe SSD. Three inputs are required for this menu. 1) Start LBA: Input start address of SSD in sector unit. The input is decimal unit when input only digit number. User can add 0x to be prefix when input is hexadecimal unit. 2) Sector Count: Input total transfer size in sector unit. The input is decimal unit when input only digit number. User can add 0x to be prefix when input is hexadecimal unit. 3) Test pattern: Select test pattern of test data for writing to SSD. Five types can be selected, i.e. 32-bit increment, 32-bit decrement, all 0, all 1, and 32-bit LFSR counter. As shown in Figure 3-2, if all inputs are valid, the operation will be started. During writing data, current transfer size is displayed on the console to show that system still run. Finally, test performance, total size, and total time usage are displayed on the console as test result. Figure 3-2 Input and result of Write Command menu 4-May-18 Page 11

12 Figure 3-3 Example Test data in sector#0/#1 by increment/lfsr pattern Test data of each sector has different 64-bit header. 64-bit header consists of 48-bit LBA address and 16-bit zero value. 48-bit LBA address is unique value for each sector. The data after 64-bit header is the test pattern which is selected by user. The example of test pattern is shown in Figure bit increment pattern is in left window and 32-bit LFSR pattern is in right window. 4-May-18 Page 12

13 Figure 3-4 Figure 3-6 show the error message when user input is invalid. Invalid input message is displayed on the console and then returns to main menu to receive new command. Figure 3-4 Invalid Start LBA input Figure 3-5 Invalid Sector count input Figure 3-6 Invalid Test pattern input 4-May-18 Page 13

14 3.3 Read Command Select 2 to send Read command to NVMe SSD. Three inputs are required for this menu. 1) Start LBA: Input start address of SSD in sector unit. The input is decimal unit when input only digit number. User can add 0x to be prefix when input is hexadecimal unit. 2) Sector Count: Input total transfer size in sector unit. The input is decimal unit when input only digit number. User can add 0x to be prefix when input is hexadecimal unit. 3) Test pattern: Select test pattern to verify data from SSD. Test pattern must be matched with the test pattern using in Write Command menu. Five types can be selected, i.e. 32-bit increment, 32-bit decrement, all 0, all 1, and 32-bit LFSR counter. Figure 3-7 Input and result of Read Command menu Similar to Write Command menu, if all inputs are valid, test system will read data from SSD. Test performance, total size, and total time usage are displayed after end of transfer. Invalid input will be displayed if some inputs are out-of-range. 4-May-18 Page 14

15 Figure 3-8 Data verification is failed but wait until read complete Figure 3-9 Data verification is failed and press any key to cancel operation Figure 3-8 and Figure 3-9 show error message when data verification is failed. Verify fail is displayed with error address, expected data, and read data. User can press any key to cancel read operation or wait until all read process complete. If read process is completed, output performance from read process will be displayed. In case of cancel operation, the previous command does not complete in good sequence. It is recommended to power-off/on all AB17 and press RESET button to restart system. 4-May-18 Page 15

16 4 Revision History Revision Date Description May-18 Initial version release 4-May-18 Page 16