Skip to content

Commit fc55475

Browse files
committed
Fix core register backlinks and naming convention
1 parent 72652eb commit fc55475

1 file changed

Lines changed: 19 additions & 19 deletions

File tree

Device.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -47,26 +47,26 @@ The following set of Device core registers MUST be implemented. These reserved r
4747

4848
|**Name**|**Volatile**|**Read Only**|**Type**|**Add.**|**Default**|**Brief Description**|**Necessity**|
4949
| :- | :-: | :-: | :-: | :-: | :-: | :- | :-: |
50-
|[`R_WHO_AM_I`](#r_who_am_i-u16--who-am-i)|-|Yes|U16|000|a)|Who am I|Required|
50+
|[`R_WHO_AM_I`](#r_who_am_i-u16--product-identifier)|-|Yes|U16|000|a)|Product identifier|Required|
5151
|[`R_HW_VERSION_H`](#r_hw_version_h-u8--major-hardware-version)|-|Yes|U8|001|a)|Major Hardware version|Deprecated|
5252
|[`R_HW_VERSION_L`](#r_hw_version_l-u8--minor-hardware-version)|-|Yes|U8|002|a)|Minor Hardware version|Deprecated|
53-
|[`R_ASSEMBLY_VERSION`](#r_assembly_version-u8--version-of-the-assembled-components)|-|Yes|U8|003|a)|Version of the assembled components|Deprecated|
53+
|[`R_ASSEMBLY_VERSION`](#r_assembly_version-u8--version-of-assembled-components)|-|Yes|U8|003|a)|Version of assembled components|Deprecated|
5454
|[`R_CORE_VERSION_H`](#r_core_version_h-u8--major-core-version)|-|Yes|U8|004|a)|Major core version|Deprecated|
5555
|[`R_CORE_VERSION_L`](#r_core_version_l-u8--minor-core-version)|-|Yes|U8|005|a)|Minor core version|Deprecated|
5656
|[`R_FW_VERSION_H`](#r_fw_version_h-u8--major-firmware-version)|-|Yes|U8|006|a)|Major Firmware version of the application|Deprecated|
5757
|[`R_FW_VERSION_L`](#r_fw_version_l-u8--minor-firmware-version)|-|Yes|U8|007|a)|Minor Firmware version of the application|Deprecated|
5858
|[`R_TIMESTAMP_SECOND`](#r_timestamp_second-u32--system-timestamp-seconds)|Yes|No|U32|008|0|System timestamp: seconds|Required|
5959
|[`R_TIMESTAMP_MICRO`](#r_timestamp_micro-u16--system-timestamp-microseconds)|Yes|Yes|U16|009|0|System timestamp: microseconds|Required|
60-
|[`R_OPERATION_CTRL`](#r_operation_ctrl-u8--operation-mode-configuration)|No|No|U8|010|b)|Configuration of the operation mode|Required|
60+
|[`R_OPERATION_CTRL`](#r_operation_ctrl-u8--operation-mode-configuration)|No|No|U8|010|b)|Configuration of the device operation mode|Required|
6161
|[`R_RESET_DEV`](#r_reset_dev-u8--reset-device-and-save-non-volatile-registers)|No|No|U8|011|b)|Reset device and save non-volatile registers|Optional|
62-
|[`R_DEVICE_NAME`](#r_device_name-25-bytes--human-readable-device-name)|No|No|U8|012|b)|Human-readable device name|Optional|
63-
|[`R_SERIAL_NUMBER`](#r_serial_number-u16--device-serial-number)|No|No|U16|013|b)|Unique serial number of the Device|Deprecated|
62+
|[`R_DEVICE_NAME`](#r_device_name-u8-array--human-readable-device-name)|No|No|U8|012|b)|Human-readable device name|Optional|
63+
|[`R_SERIAL_NUMBER`](#r_serial_number-u16--device-serial-number)|No|No|U16|013|b)|Unique serial number of the device|Deprecated|
6464
|[`R_CLOCK_CONFIG`](#r_clock_config-u8--synchronization-clock-configuration)|No|No|U8|014|b)|Synchronization clock configuration|Optional|
6565
|[`R_TIMESTAMP_OFFSET`](#r_timestamp_offset-u8--clock-calibration-offset)|No|No|U8|015|b)|Configures an offset for Timestamp updates|Deprecated|
6666
|[`R_UID`](#r_uid-16-bytes--unique-identifier)|No|Yes|U8|016|b)|Stores a unique identifier (UID) |Optional|
6767
|[`R_TAG`](#r_tag-8-bytes--firmware-tag)|-|Yes|U8|017|b)|Firmware tag|Optional|
68-
|[`R_HEARTBEAT`](#r_heartbeat-u16--heartbeat-register-reporting-the-current-status-of-the-device)|Yes|Yes|U16|018|b)|Monitors the state of the Device|Required|
69-
|[`R_VERSION`](#r_version-u8--semantic-version-information)|-|Yes|U8|019|a)|Semantic version information for the Device|Required|
68+
|[`R_HEARTBEAT`](#r_heartbeat-u16--device-status-information)|Yes|Yes|U16|018|b)|Monitors device status|Required|
69+
|[`R_VERSION`](#r_version-u8--device-version-information)|-|Yes|U8|019|a)|Device version information|Required|
7070

7171
||a) These values MUST be stored during the firmware build process and are persistent, i.e. they SHALL NOT be changeable by the Controller.<br>b) Check register notes on the specific register explanation |
7272
| :- | :- |
@@ -76,7 +76,7 @@ Tables can be generated here https://www.tablesgenerator.com/html_tables
7676
Mermaid plots can be generated here: https://mermaid.live/
7777
--->
7878

79-
### **`R_WHO_AM_I` (U16) – Who Am I**
79+
### **`R_WHO_AM_I` (U16) – Product identifier**
8080

8181
Address: `000`
8282

@@ -233,7 +233,7 @@ b) `Standby` and `Active` modes are mandatory. `Speed` mode is deprecated.
233233
>
234234
> The Device MUST reply with `Error` in case this operation mode is not supported.
235235
236-
* **HEARTBEAT_EN [Bit 2]:** If this bit is set, the Device MUST send an `Event` message every second with the contents of [`R_HEARTBEAT`](#r_heartbeat-u16--heartbeat-register-reporting-the-current-status-of-the-device). This allows the Controller to check the status of the Device periodically. If the `ALIVE_EN` bit is also set, this bit has precedence and the Device must send `R_HEARTBEAT` periodically instead of `R_TIMESTAMP_SECOND`.
236+
* **HEARTBEAT_EN [Bit 2]:** If this bit is set, the Device MUST send an `Event` message every second with the contents of [`R_HEARTBEAT`](#r_heartbeat-u16--device-status-information). This allows the Controller to check the status of the Device periodically. If the `ALIVE_EN` bit is also set, this bit has precedence and the Device must send `R_HEARTBEAT` periodically instead of `R_TIMESTAMP_SECOND`.
237237
* **DUMP [Bit 3]:** If this bit is set on a `Write` request, the Device SHALL send a sequence of `Read` messages to the Controller, one per register, with the current contents of all core and application registers. These messages MUST be sent following the `Write` reply to the request from the Controller. When sending a reply to a `Read` request, the Device MUST clear this bit in the message payload.
238238
* **MUTE_RPL [Bit 4]:** If this bit is set, the Device SHALL NOT send any messages in reply to a request from the Controller.
239239
* **VISUAL_EN [Bit 5]:** If this bit is set, any visual indicators, typically LEDs, available on the Device SHOULD be enabled. Otherwise, if the bit is cleared, all visual indicators SHOULD be turned off.
@@ -436,7 +436,7 @@ An array of 8 bytes that can be used to store a tag for a specific firmware buil
436436

437437
If not implemented, the Device MUST return a default value of `0` (Zero) for all bytes.
438438

439-
### **`R_HEARTBEAT` (U16) – Heartbeat register reporting the current status of the device**
439+
### **`R_HEARTBEAT` (U16) – Device status information**
440440

441441
Address: `018`
442442

@@ -471,7 +471,7 @@ This register is read-only and used to provide status information about the Devi
471471

472472
* **IS_SYNCHRONIZED [Bit 1]:** If this bit is set, the Device MUST be synchronized with an external Harp clock generator. If the Device is itself a clock generator (see [`R_CLOCK_CONFIG`](#r_clock_config-u8--synchronization-clock-configuration) bit `CLK_GEN`), this bit MUST always be set.
473473

474-
### **`R_VERSION` (U8) – Semantic version information**
474+
### **`R_VERSION` (U8) – Device version information**
475475

476476
Address: `019`
477477

@@ -512,7 +512,7 @@ gantt
512512
- :d4, after sdk_id, 32
513513
```
514514

515-
The bytes in this register specify the [semantic version](https://semver.org/) of different Device components. Each component version is made up of three bytes, following the order `major`, `minor`, `patch`. The register also includes a unique identifier of the core microcontroller SDK and a hash digest of the interface schema file describing the Device Interface.
515+
The bytes in this register specify the [semantic version](https://semver.org/) of the components making up the Device. Each component version is made up of three bytes, following the order `major`, `minor`, `patch`. The register also includes a unique identifier of the core microcontroller SDK and a hash digest of the interface schema file describing the Device Interface.
516516

517517
* **PROTOCOL:** The semantic version of the Harp protocol implemented by the Device.
518518

@@ -532,7 +532,7 @@ The following registers are deprecated and their functionality SHOULD NOT be imp
532532

533533
> [!WARNING]
534534
>
535-
> This register is deprecated in favor of [`R_VERSION`](#r_version-u8--semantic-version-information). The value of this register MUST be equal to the major `HARDWARE` version in `R_VERSION`.
535+
> This register is deprecated in favor of [`R_VERSION`](#r_version-u8--device-version-information). The value of this register MUST be equal to the major `HARDWARE` version in `R_VERSION`.
536536
537537
Address: `001`
538538

@@ -562,7 +562,7 @@ Specifies the major hardware version number. The value of this register is persi
562562

563563
> [!WARNING]
564564
>
565-
> This register is deprecated in favor of [`R_VERSION`](#r_version-u8--semantic-version-information). The value of this register MUST be equal to the minor `HARDWARE` version in `R_VERSION`.
565+
> This register is deprecated in favor of [`R_VERSION`](#r_version-u8--device-version-information). The value of this register MUST be equal to the minor `HARDWARE` version in `R_VERSION`.
566566
567567
Address: `002`
568568

@@ -588,7 +588,7 @@ gantt
588588

589589
Specifies the minor hardware version number. The value of this register is persistent and MUST NOT be changeable by the Controller.
590590

591-
### **`R_ASSEMBLY_VERSION` (U8) – Version of the Assembled Components**
591+
### **`R_ASSEMBLY_VERSION` (U8) – Version of Assembled Components**
592592

593593
> [!WARNING]
594594
>
@@ -622,7 +622,7 @@ Specifies the version number of the assembled components. The value of this regi
622622

623623
> [!WARNING]
624624
>
625-
> This register is deprecated in favor of [`R_VERSION`](#r_version-u8--semantic-version-information). The value of this register MUST be equal to the major `PROTOCOL` version in `R_VERSION`.
625+
> This register is deprecated in favor of [`R_VERSION`](#r_version-u8--device-version-information). The value of this register MUST be equal to the major `PROTOCOL` version in `R_VERSION`.
626626
627627
Address: `004`
628628

@@ -652,7 +652,7 @@ Contains the major version of the Harp protocol specification. The value of this
652652

653653
> [!WARNING]
654654
>
655-
> This register is deprecated in favor of [`R_VERSION`](#r_version-u8--semantic-version-information). The value of this register MUST be equal to the minor `PROTOCOL` version in `R_VERSION`.
655+
> This register is deprecated in favor of [`R_VERSION`](#r_version-u8--device-version-information). The value of this register MUST be equal to the minor `PROTOCOL` version in `R_VERSION`.
656656
657657
Address: `005`
658658

@@ -682,7 +682,7 @@ Contains the minor version of the Harp Protocol specification. The value of this
682682

683683
> [!WARNING]
684684
>
685-
> This register is deprecated in favor of [`R_VERSION`](#r_version-u8--semantic-version-information). The value of this register MUST be equal to the major `FIRMWARE` version in `R_VERSION`.
685+
> This register is deprecated in favor of [`R_VERSION`](#r_version-u8--device-version-information). The value of this register MUST be equal to the major `FIRMWARE` version in `R_VERSION`.
686686
687687
Address: `006`
688688

@@ -712,7 +712,7 @@ Contains the major firmware version number. The value of this register is persis
712712

713713
> [!WARNING]
714714
>
715-
> This register is deprecated in favor of [`R_VERSION`](#r_version-u8--semantic-version-information). The value of this register MUST be equal to the minor `FIRMWARE` version in `R_VERSION`.
715+
> This register is deprecated in favor of [`R_VERSION`](#r_version-u8--device-version-information). The value of this register MUST be equal to the minor `FIRMWARE` version in `R_VERSION`.
716716
717717
```mermaid
718718
---

0 commit comments

Comments
 (0)