updated readme

timkostka · Jul 11, 2020 · 1555c5b · 1555c5b
1 parent 94ec4f7
commit 1555c5b
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 22 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+.idea/*
+venv/*
diff --git a/readme.md b/readme.md
@@ -1,30 +1,46 @@
+# SDMMC from SPI
+
 This is a high-level analyzer (HLA) for decoding SD and MMC comminication with a Saleae logic analyzer.
 
-### Setup
+## Setup
 
 To use this extension, do the following:
 
-* Install Saleae Logic 2.
-  * As of the time of writing, the latest version was v2.2.17.
+### Install Saleae Logic 2
+
+As of the time of writing, the latest version was v2.3.2.
+
+### Install this extension
+
+1. Download all files to a directory on your computer
+
+2. In the "Extensions" tab, select "Create Extension" and select "Load existing extension."
+
+3. Select the "sdmmc_from_spi.json" file on your computer.
+
+### Create an SPI analyzer
+
+1. MOSI mapped to SDIO_CMD
+
+2. MISO unmapped
+
+3. Clock mapped to SDIO/CK
 
-* Install this extension in Logic 2.
-  * Downloading the "hla" directory to your computer.
-  * In the "Extensions" tab, select "Create Extension" and select "Load existing extension."
-  * Select the "sdmmc_from_spi.json" file on your computer.
+4. Enable unmapped (important)
+
+5. MSB first
+
+6. 8 bits per transfer
+
+7. CPOL = 0
+
+8. CPHA = 0
 
-* Create an SPI analyzer with the following inputs:
-  * MOSI mapped to SDIO_CMD
-  * MISO unmapped
-  * Clock mapped to SDIO/CK
-  * Enable unmapped (important)
-  * MSB first
-  * 8 bits per transfer
-  * CPOL = 0
-  * CPHA = 0
+### Create an "SDMMC from SPI" analyzer
 
-* Create an SDMMC (from SPI) analyzer with the above SPI analyzer as the input.
+Use the SPI analyzer above as the input.
 
-### Example
+## Example
 
 The SPI analyzer should be outputting results similiar to the following:
 
@@ -36,7 +52,7 @@ When there is activity on the CMD line, the analyzer will output info about it.
 
 ![](.readme_images/sdmmc_identification_example.png)
 
-### Notes
+## Notes
 
 This extension is not compatible with Saleae Logic 1.x.
 

diff --git a/hla/sdmmc_from_spi.json → sdmmc_from_spi.json b/hla/sdmmc_from_spi.json → sdmmc_from_spi.json
@@ -1,9 +1,9 @@
 {
-  "version": "1.0.0",
-  "apiVersion": "1.0.0",
+  "name": "SDMMC from SPI",
+  "version": "20.7.2",
   "author": "Tim Kostka <[email protected]>",
   "description": "Saleae Logic 2.x high level analyzer for SD/MMC communication",
-  "name": "SDMMC from SPI",
+  "apiVersion": "1.0.0",
   "extensions": {
     "SDMMC from SPI": {
       "type": "HighLevelAnalyzer",

diff --git a/hla/sdmmc_from_spi.py → sdmmc_from_spi.py b/hla/sdmmc_from_spi.py → sdmmc_from_spi.py