From bf9628ee0db3491bc9c80d85144c1fa7acecaf39 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Wed, 17 Jan 2024 17:42:50 +0000 Subject: [PATCH] Update Firmware Documentation --- docs/firmware/html/a00020.html | 27 +++ docs/firmware/html/a00077.html | 78 +++++++- docs/firmware/html/globals.html | 27 +++ docs/firmware/html/globals_enum.html | 3 + docs/firmware/html/globals_eval.html | 21 ++ docs/firmware/html/globals_vars.html | 3 + docs/firmware/html/search/all_10.js | 24 +-- docs/firmware/html/search/all_11.js | 10 +- docs/firmware/html/search/all_12.js | 38 ++-- docs/firmware/html/search/all_13.js | 12 +- docs/firmware/html/search/all_14.js | 38 ++-- docs/firmware/html/search/all_9.js | 183 +++++++++--------- docs/firmware/html/search/all_a.js | 10 +- docs/firmware/html/search/all_b.js | 20 +- docs/firmware/html/search/all_c.js | 44 ++--- docs/firmware/html/search/all_d.js | 44 ++--- docs/firmware/html/search/all_e.js | 24 +-- docs/firmware/html/search/all_f.js | 62 +++--- docs/firmware/html/search/classes_0.js | 8 +- docs/firmware/html/search/classes_1.js | 4 +- docs/firmware/html/search/classes_2.js | 10 +- docs/firmware/html/search/classes_3.js | 4 +- docs/firmware/html/search/classes_4.js | 6 +- docs/firmware/html/search/classes_5.js | 8 +- docs/firmware/html/search/classes_6.js | 4 +- docs/firmware/html/search/classes_7.js | 4 +- docs/firmware/html/search/classes_8.js | 4 +- docs/firmware/html/search/classes_9.js | 2 +- docs/firmware/html/search/classes_a.js | 8 +- docs/firmware/html/search/classes_b.js | 2 +- docs/firmware/html/search/classes_c.js | 14 +- docs/firmware/html/search/enums_0.js | 2 +- docs/firmware/html/search/enums_1.js | 7 +- docs/firmware/html/search/enumvalues_0.js | 8 +- docs/firmware/html/search/enumvalues_1.js | 101 +++++----- docs/firmware/html/search/files_0.js | 16 +- docs/firmware/html/search/files_1.js | 8 +- docs/firmware/html/search/files_2.js | 4 +- docs/firmware/html/search/files_3.js | 2 +- docs/firmware/html/search/files_4.js | 8 +- docs/firmware/html/search/files_5.js | 8 +- docs/firmware/html/search/files_6.js | 8 +- docs/firmware/html/search/files_7.js | 10 +- docs/firmware/html/search/files_8.js | 8 +- docs/firmware/html/search/files_9.js | 8 +- docs/firmware/html/search/files_a.js | 4 +- docs/firmware/html/search/files_b.js | 16 +- docs/firmware/html/search/files_c.js | 2 +- docs/firmware/html/search/files_d.js | 8 +- docs/firmware/html/search/functions_0.js | 10 +- docs/firmware/html/search/functions_1.js | 14 +- docs/firmware/html/search/functions_10.js | 10 +- docs/firmware/html/search/functions_11.js | 38 ++-- docs/firmware/html/search/functions_2.js | 12 +- docs/firmware/html/search/functions_3.js | 6 +- docs/firmware/html/search/functions_4.js | 58 +++--- docs/firmware/html/search/functions_5.js | 8 +- docs/firmware/html/search/functions_6.js | 32 +-- docs/firmware/html/search/functions_7.js | 10 +- docs/firmware/html/search/functions_8.js | 8 +- docs/firmware/html/search/functions_9.js | 30 +-- docs/firmware/html/search/functions_a.js | 20 +- docs/firmware/html/search/functions_b.js | 16 +- docs/firmware/html/search/functions_c.js | 44 ++--- docs/firmware/html/search/functions_d.js | 14 +- docs/firmware/html/search/functions_e.js | 6 +- docs/firmware/html/search/functions_f.js | 14 +- docs/firmware/html/search/groups_0.js | 2 +- docs/firmware/html/search/groups_1.js | 2 +- docs/firmware/html/search/pages_0.js | 2 +- docs/firmware/html/search/related_0.js | 4 +- docs/firmware/html/search/typedefs_0.js | 2 +- docs/firmware/html/search/typedefs_1.js | 6 +- docs/firmware/html/search/variables_0.js | 12 +- docs/firmware/html/search/variables_1.js | 6 +- docs/firmware/html/search/variables_2.js | 14 +- docs/firmware/html/search/variables_3.js | 127 ++++++------ docs/firmware/html/search/variables_4.js | 4 +- docs/firmware/html/search/variables_5.js | 16 +- docs/firmware/html/search/variables_6.js | 4 +- docs/firmware/html/search/variables_7.js | 14 +- docs/firmware/html/search/variables_8.js | 2 +- .../circuits/74hc165.cpp.func-sort-c.html | 6 +- .../lcov/circuits/74hc165.cpp.func.html | 6 +- .../lcov/circuits/74hc165.cpp.gcov.html | 6 +- .../circuits/74hc595.cpp.func-sort-c.html | 6 +- .../lcov/circuits/74hc595.cpp.func.html | 6 +- .../lcov/circuits/74hc595.cpp.gcov.html | 6 +- .../lcov/circuits/dc2dc.cpp.func-sort-c.html | 12 +- .../lcov/circuits/dc2dc.cpp.func.html | 12 +- .../lcov/circuits/dc2dc.cpp.gcov.html | 62 +++--- docs/firmware/lcov/circuits/index-sort-f.html | 6 +- docs/firmware/lcov/circuits/index-sort-l.html | 6 +- docs/firmware/lcov/circuits/index.html | 6 +- .../lcov/hal/adc.cpp.func-sort-c.html | 14 +- docs/firmware/lcov/hal/adc.cpp.func.html | 14 +- docs/firmware/lcov/hal/adc.cpp.gcov.html | 52 ++--- .../lcov/hal/flash.cpp.func-sort-c.html | 6 +- docs/firmware/lcov/hal/flash.cpp.func.html | 6 +- docs/firmware/lcov/hal/flash.cpp.gcov.html | 6 +- .../lcov/hal/gpio.cpp.func-sort-c.html | 6 +- docs/firmware/lcov/hal/gpio.cpp.func.html | 6 +- docs/firmware/lcov/hal/gpio.cpp.gcov.html | 6 +- docs/firmware/lcov/hal/index-sort-f.html | 22 +-- docs/firmware/lcov/hal/index-sort-l.html | 6 +- docs/firmware/lcov/hal/index.html | 6 +- .../lcov/hal/multicore.cpp.func-sort-c.html | 10 +- .../firmware/lcov/hal/multicore.cpp.func.html | 10 +- .../firmware/lcov/hal/multicore.cpp.gcov.html | 16 +- .../lcov/hal/pwm.cpp.func-sort-c.html | 10 +- docs/firmware/lcov/hal/pwm.cpp.func.html | 10 +- docs/firmware/lcov/hal/pwm.cpp.gcov.html | 26 +-- .../lcov/hal/serial.cpp.func-sort-c.html | 6 +- docs/firmware/lcov/hal/serial.cpp.func.html | 6 +- docs/firmware/lcov/hal/serial.cpp.gcov.html | 6 +- .../lcov/hal/string.cpp.func-sort-c.html | 6 +- docs/firmware/lcov/hal/string.cpp.func.html | 6 +- docs/firmware/lcov/hal/string.cpp.gcov.html | 6 +- docs/firmware/lcov/index-sort-f.html | 6 +- docs/firmware/lcov/index-sort-l.html | 6 +- docs/firmware/lcov/index.html | 6 +- docs/firmware/lcov/modules/index-sort-f.html | 6 +- docs/firmware/lcov/modules/index-sort-l.html | 6 +- docs/firmware/lcov/modules/index.html | 6 +- .../lcov/modules/opcodes.cpp.func-sort-c.html | 6 +- .../lcov/modules/opcodes.cpp.func.html | 6 +- .../lcov/modules/opcodes.cpp.gcov.html | 6 +- .../modules/vgenerator.cpp.func-sort-c.html | 8 +- .../lcov/modules/vgenerator.cpp.func.html | 8 +- .../lcov/modules/vgenerator.cpp.gcov.html | 22 +-- 130 files changed, 1099 insertions(+), 942 deletions(-) diff --git a/docs/firmware/html/a00020.html b/docs/firmware/html/a00020.html index 26c1f608..b4b56713 100644 --- a/docs/firmware/html/a00020.html +++ b/docs/firmware/html/a00020.html @@ -257,6 +257,9 @@ constexpr uint32_t kStabilizationTime = 150  GENERAL : Time for stabilization, in microseconds. More...
  +constexpr uint32_t kErasePulseDuration = 100 + GENERAL : Erase pulse duration, in milliseconds. More...

Detailed Description

Configuration of UsbFlashProg.

@@ -1556,6 +1559,30 @@

+

◆ kErasePulseDuration

+ +
+
+ + + + + +
+ + + + +
constexpr uint32_t kErasePulseDuration = 100
+
+constexpr
+
+ +

GENERAL : Erase pulse duration, in milliseconds.

+

diff --git a/docs/firmware/html/a00077.html b/docs/firmware/html/a00077.html index a14e2a95..db185f52 100644 --- a/docs/firmware/html/a00077.html +++ b/docs/firmware/html/a00077.html @@ -164,17 +164,28 @@ , kCmdDeviceSetTwc = 0x82 ,
  kCmdDeviceSetFlags = 0x83 -, kCmdDeviceRead = 0x84 -, kCmdDeviceReadB = 0x85 -, kCmdDeviceWrite = 0x86 +, kCmdDeviceSetupBus = 0x84 +, kCmdDeviceRead = 0x85 +, kCmdDeviceReadB = 0x86 ,
-  kCmdDeviceWriteB = 0x87 -, kCmdDeviceVerify = 0x88 -, kCmdDeviceVerifyB = 0x89 +  kCmdDeviceWrite = 0x87 +, kCmdDeviceWriteB = 0x88 +, kCmdDeviceVerify = 0x89 +, kCmdDeviceVerifyB = 0x8A +,
+  kCmdDeviceGetId = 0x8B +, kCmdDeviceErase = 0x8C
}  Enumeration of the OpCodes. More...
  +enum  kCmdDeviceOperationEnum { kCmdDeviceOperationReset = 0x00 +, kCmdDeviceOperationRead = 0x01 +, kCmdDeviceOperationProg = 0x02 +, kCmdDeviceOperationGetId = 0x03 + } + Enumeration of the Device Operations. More...

Detailed Description

Opcodes for communication.

@@ -328,7 +339,7 @@

kCmdDeviceSetTwc 

OPCODE / DEVICE : Opcode Device Set tWC.

kCmdDeviceSetFlags 

OPCODE / DEVICE : Opcode Device Set Flags.

-

The parameter (one byte) that represents the flags follows the table:

+

The parameter (one byte) represents the flags, and follows the table:

 +----------------------+
 |Bit| Description      |
 | 0 | Skip Write 0xFF  |
@@ -338,18 +349,65 @@ 

kCmdDeviceRead 

OPCODE / DEVICE : Opcode Device Read and Increment Address.

+kCmdDeviceSetupBus 

OPCODE / DEVICE : Opcode Device Setup Bus.

+

The first parameter (one byte) represents the operation, and follows the table:

++------------------------------+
+|Operation| Description        |
+|  0x00   | Reset Bus          |
+|  0x01   | Prepare to Read    |
+|  0x02   | Prepare to Program |
++------------------------------+
+
See also
kCmdDeviceOperationEnum
+ +kCmdDeviceRead 

OPCODE / DEVICE : Opcode Device Read Word and Increment Address.

kCmdDeviceReadB 

OPCODE / DEVICE : Opcode Device Read Byte and Increment Address.

-kCmdDeviceWrite 

OPCODE / DEVICE : Opcode Device Write, Verify and Increment Address.

+kCmdDeviceWrite 

OPCODE / DEVICE : Opcode Device Write Word, Verify and Increment Address.

kCmdDeviceWriteB 

OPCODE / DEVICE : Opcode Device Write Byte, Verify and Increment Address.

-kCmdDeviceVerify 

OPCODE / DEVICE : Opcode Device Verify and Increment Address.

+kCmdDeviceVerify 

OPCODE / DEVICE : Opcode Device Verify Word and Increment Address.

kCmdDeviceVerifyB 

OPCODE / DEVICE : Opcode Device Verify Byte and Increment Address.

+kCmdDeviceGetId 

OPCODE / DEVICE : Opcode Device Get ID.

+

The result (two bytes) represents Manufacturer/Device ID, following the table:

++-------------------------------+
+|Response      | Description    |
+| First (MSB)  | Manufacurer ID |
+| Second (LSB) | Device ID      |
++-------------------------------+
+
+kCmdDeviceErase 

OPCODE / DEVICE : Opcode Device Erase.

+ + + +

+ + +

◆ kCmdDeviceOperationEnum

+ +
+
+ + + + +
enum kCmdDeviceOperationEnum
+
+ +

Enumeration of the Device Operations.

+
See also
kCmdDeviceSetupBus
+ + + + +
Enumerator
kCmdDeviceOperationReset 

CMD / DEVICE : Defines a operation Reset.

+
kCmdDeviceOperationRead 

CMD / DEVICE : Defines a operation Read.

+
kCmdDeviceOperationProg 

CMD / DEVICE : Defines a operation Program.

+
kCmdDeviceOperationGetId 

CMD / DEVICE : Defines a operation Get ID.

+
diff --git a/docs/firmware/html/globals.html b/docs/firmware/html/globals.html index 9d1b6dda..66a72b08 100644 --- a/docs/firmware/html/globals.html +++ b/docs/firmware/html/globals.html @@ -140,6 +140,27 @@

- k -