Skip to content

Commit badc8f1

Browse files
Change doc versioning to clearly match I2C protocol versioning (#11)
1 parent d5015f5 commit badc8f1

File tree

1 file changed

+32
-5
lines changed

1 file changed

+32
-5
lines changed

spec/index.md

Lines changed: 32 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,16 @@ lang: en
1010

1111
# micro:bit I2C Protocol Specification
1212

13-
This is version 0.9.1 of the specification.
13+
This is version 1.00 of the specification.
1414

1515
- [Glossary](#glossary)
16+
- [Versioning](#versioning)
1617
- [Introduction](#introduction)
1718
- [I2C Secondary addresses](#i2c-secondary-addresses)
1819
- [I2C nRF - KL27 config/comms interface](#i2c-nrf--kl27-configcomms-interface)
1920
- [I2C Flash interface](#i2c-flash-interface)
20-
- [HID Interface](#hid-interface)
21-
21+
- [I2C HID Interface](#i2c-hid-interface)
22+
- [Doc Updates](#doc-updates)
2223

2324
## Glossary
2425

@@ -33,6 +34,16 @@ This is version 0.9.1 of the specification.
3334
| UART | [Universal asynchronous receiver-transmitter](https://en.wikipedia.org/wiki/Universal_asynchronous_receiver-transmitter) |
3435

3536

37+
## Versioning
38+
39+
The version follows a `major.minor` configuration.
40+
41+
- `major`: Indicates a change or addition to the procotol, this is usually accompanied by a new DAPLink release.
42+
- `minor`: Indicates an update, fix, or clarification to the documentation **only**. No changes required to the protocol implementations.
43+
44+
The `I2C protocol version` property returns only the major version.
45+
46+
3647
## Introduction
3748

3849
The micro:bit contains two microcontrollers, the Interface MCU which provides the USB functionality, and the Target MCU where the user code runs.
@@ -136,7 +147,10 @@ The additional features provided by the Interface (KL27) via I2C are:
136147
<tr class="even">
137148
<td>I2C protocol version (R)</td>
138149
<td>0x02</td>
139-
<td>Size: 2B e.g. 0x0001</td>
150+
<td>
151+
Size: 2B e.g. 0x0001<br />
152+
Value only includes major version
153+
</td>
140154
</tr>
141155
<tr class="odd">
142156
<td>DAPLink version (R)</td>
@@ -206,6 +220,8 @@ The additional features provided by the Interface (KL27) via I2C are:
206220
</tbody>
207221
</table>
208222

223+
224+
209225
#### Error codes
210226

211227
| Error | Error Code |
@@ -388,7 +404,18 @@ KL27 storage memory layout:
388404

389405
KL27 storage area should be writeable via Universal Hex.
390406

407+
This is not yet implemented.
408+
391409

392-
## HID Interface
410+
## I2C HID Interface
393411

394412
All I2C features should be available via HID interface, so that it can be accessed via WebUSB.
413+
414+
This is not yet implemented.
415+
416+
417+
## Doc Updates
418+
419+
| Version | Changes |
420+
|---------|---------|
421+
| 1.00 | Initial release, as implemented in DAPLink 0255 |

0 commit comments

Comments
 (0)