drivers: mipi_dbi: doc: fix clock in waveform diagram

rexut · kartben · commit 0c93541bb579 · 2024-12-09T15:12:21.000+01:00
In the Doxygen comments, the amount of SPI clocks now match the
number of data bits shown. The clock was shown half the speed.

Signed-off-by: Stephan Linz &lt;linz@li-pro.net&gt;
diff --git a/include/zephyr/dt-bindings/mipi_dbi/mipi_dbi.h b/include/zephyr/dt-bindings/mipi_dbi/mipi_dbi.h
@@ -20,15 +20,15 @@
  * command or data byte
  *
  *
- *           .---.   .---.   .---.   .---.   .---.   .---.   .---.   .---.
- *     SCK  -'   '---'   '---'   '---'   '---'   '---'   '---'   '---'   '---
+ *           .-. .-. .-. .-. .-. .-. .-. .-. .-. .-. .-. .-. .-. .-. .-. .-
+ *     SCK  -' '-' '-' '-' '-' '-' '-' '-' '-' '-' '-' '-' '-' '-' '-' '-'
  *
- *          -.---.---.---.---.---.---.---.---.---.---.---.---.---.---.---.
+ *          -.---.---.---.---.---.---.---.---.---.---.---.---.---.---.---.-
  *     DOUT  |D/C| D7| D6| D5| D4| D3| D2| D1| D0|D/C| D7| D6| D5| D4|...|
- *          -'---'---'---'---'---'---'---'---'---'---'---'---'---'---'---'
+ *          -'---'---'---'---'---'---'---'---'---'---'---'---'---'---'---'-
  *           | Word 1                            | Word n
  *
- *          -.								 .--
+ *          -.								 .-
  *     CS    '-----------------------------------------------------------'
  */
 #define MIPI_DBI_MODE_SPI_3WIRE 0x1
@@ -37,15 +37,15 @@
  * an additional C/D pin will be use to indicate whether the byte is a
  * command or data byte
  *
- *           .---.   .---.   .---.   .---.   .---.   .---.   .---.   .---.
- *     SCK  -'   '---'   '---'   '---'   '---'   '---'   '---'   '---'   '---
+ *           .-. .-. .-. .-. .-. .-. .-. .-. .-. .-. .-. .-. .-. .-. .-. .-.
+ *     SCK  -' '-' '-' '-' '-' '-' '-' '-' '-' '-' '-' '-' '-' '-' '-' '-' '---
  *
- *          -.---.---.---.---.---.---.---.---.---.---.---.---.---.---.---.---.
+ *          -.---.---.---.---.---.---.---.---.---.---.---.---.---.---.---.---.-
  *     DOUT  | D7| D6| D5| D4| D3| D2| D1| D0| D7| D6| D5| D4| D3| D2| D1| D0|
- *          -'---'---'---'---'---'---'---'---'---'---'---'---'---'---'---'---'
+ *          -'---'---'---'---'---'---'---'---'---'---'---'---'---'---'---'---'-
  *           | Word 1                        | Word n
  *
- *          -.								     .--
+ *          -.								     .-
  *     CS    '---------------------------------------------------------------'
  *
  *          -.-------------------------------.-------------------------------.-

Original file line number	Diff line number	Diff line change
`@@ -20,15 +20,15 @@`
`20`	`20`	`* command or data byte`
`21`	`21`	`*`
`22`	`22`	`*`
`23`		`- * .---. .---. .---. .---. .---. .---. .---. .---.`
`24`		`- * SCK -' '---' '---' '---' '---' '---' '---' '---' '---`
	`23`	`+ * .-. .-. .-. .-. .-. .-. .-. .-. .-. .-. .-. .-. .-. .-. .-. .-`
	`24`	`+ * SCK -' '-' '-' '-' '-' '-' '-' '-' '-' '-' '-' '-' '-' '-' '-' '-'`
`25`	`25`	`*`
`26`		`- * -.---.---.---.---.---.---.---.---.---.---.---.---.---.---.---.`
	`26`	`+ * -.---.---.---.---.---.---.---.---.---.---.---.---.---.---.---.-`
`27`	`27`	`* DOUT \|D/C\| D7\| D6\| D5\| D4\| D3\| D2\| D1\| D0\|D/C\| D7\| D6\| D5\| D4\|...\|`
`28`		`- * -'---'---'---'---'---'---'---'---'---'---'---'---'---'---'---'`
	`28`	`+ * -'---'---'---'---'---'---'---'---'---'---'---'---'---'---'---'-`
`29`	`29`	`* \| Word 1 \| Word n`
`30`	`30`	`*`
`31`		`- * -. .--`
	`31`	`+ * -. .-`
`32`	`32`	`* CS '-----------------------------------------------------------'`
`33`	`33`	`*/`
`34`	`34`	`#define MIPI_DBI_MODE_SPI_3WIRE 0x1`
`@@ -37,15 +37,15 @@`
`37`	`37`	`* an additional C/D pin will be use to indicate whether the byte is a`
`38`	`38`	`* command or data byte`
`39`	`39`	`*`
`40`		`- * .---. .---. .---. .---. .---. .---. .---. .---.`
`41`		`- * SCK -' '---' '---' '---' '---' '---' '---' '---' '---`
	`40`	`+ * .-. .-. .-. .-. .-. .-. .-. .-. .-. .-. .-. .-. .-. .-. .-. .-.`
	`41`	`+ * SCK -' '-' '-' '-' '-' '-' '-' '-' '-' '-' '-' '-' '-' '-' '-' '-' '---`
`42`	`42`	`*`
`43`		`- * -.---.---.---.---.---.---.---.---.---.---.---.---.---.---.---.---.`
	`43`	`+ * -.---.---.---.---.---.---.---.---.---.---.---.---.---.---.---.---.-`
`44`	`44`	`* DOUT \| D7\| D6\| D5\| D4\| D3\| D2\| D1\| D0\| D7\| D6\| D5\| D4\| D3\| D2\| D1\| D0\|`
`45`		`- * -'---'---'---'---'---'---'---'---'---'---'---'---'---'---'---'---'`
	`45`	`+ * -'---'---'---'---'---'---'---'---'---'---'---'---'---'---'---'---'-`
`46`	`46`	`* \| Word 1 \| Word n`
`47`	`47`	`*`
`48`		`- * -. .--`
	`48`	`+ * -. .-`
`49`	`49`	`* CS '---------------------------------------------------------------'`
`50`	`50`	`*`
`51`	`51`	`* -.-------------------------------.-------------------------------.-`