Skip to content

Commit 87b7deb

Browse files
committed
docs: Add note about bridge allocations on BusOwner1.LearnEndpoint method
Signed-off-by: Jeremy Kerr <jk@codeconstruct.com.au>
1 parent a985b9c commit 87b7deb

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/mctpd.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,14 @@ Like SetupEndpoint but will not assign EIDs, will only query endpoints for a
152152
current EID. The `new` return value is set to `false` for an already known
153153
endpoint, or `true` when an endpoint's EID is newly discovered.
154154

155+
Because we are not issuing a Set Endpoint ID as part of the LearnEndpoint call,
156+
we do not have any details of the endpoint's bridge pool range. So,
157+
LearnEndpoint is unsuitable for use with bridge endpoints - it cannot provide
158+
the bridge with its own EID pool. `mctpd` will warn if the device type
159+
reports as a bridge.
160+
161+
Bridge endpoints should be initialised with `AssignEndpoint` instead.
162+
155163
## Network objects: `/au/com/codeconstruct/networks/<net>`
156164

157165
These objects represent MCTP networks which have been added use `mctp link`

0 commit comments

Comments
 (0)