Skip to content

Commit aaba669

Browse files
committed
docs, CHANGELOG: Add details of VDM type registration behaviour
Signed-off-by: Jeremy Kerr <jk@codeconstruct.com.au>
1 parent 0937b1f commit aaba669

2 files changed

Lines changed: 16 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,15 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
1212

1313
1. Fixed `mctp-bench` compile on musl libc
1414

15+
### Changed
16+
17+
1. `mctpd`'s `RegisterTypeSupport` dbus method will no longer allow the
18+
VDM messaging types (0x7e and 0x7f) to be registered, as these do not
19+
make sense without a corresponding VDM type registration.
20+
21+
Registering a VDM type will automatically include the corresponding VDM type
22+
in the Get Message Type Support response.
23+
1524
### Added
1625

1726
1. `mctpd` now implements the Get Vendor Define Message Support control protocol

docs/mctpd.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,10 @@ If the message type is already registered, then dbus call will fail.
5050
- `<versions>` Versions supported for this message type formatted as uint32
5151
integers as specified in DSP0236
5252

53+
The `msg_type` value must be a valid message type, and cannot be one of the
54+
VDM types (0x7e or 0x7f). Those VDM types are handled by the
55+
`RegisterVDMTypeSupport` method instead.
56+
5357
De-registration is automatic - the specified types (and versions) are registered
5458
for as long as the dbus sender remains attached to the message bus, and are
5559
unregistered on disconnect.
@@ -72,6 +76,9 @@ If the VDM type is already registered, then dbus call will fail.
7276
- For IANA format: 32-bit unsigned integer (`u`)
7377
- `<command set type>` Command set type (16-bit unsigned integer) as defined by the vendor
7478

79+
Registering a VDM type will cause the corresponding VDM type value (0x7e or
80+
0x7f) to be returned in mctpd's Get Message Type Support response.
81+
7582
De-registration is automatic - the specified VDM types are registered for as
7683
long as the dbus sender remains attached to the message bus, and are
7784
removed when the sender disconnects.

0 commit comments

Comments
 (0)