Skip to content

Commit 7686f6c

Browse files
committed
docs: mctpd: minor bridge doc fixes
Spacing fixes, and a simplification for the Bridge1 interface description. Re-order pool properties to describe in start -> end order. Signed-off-by: Jeremy Kerr <jk@codeconstruct.com.au>
1 parent c5a6bc9 commit 7686f6c

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

docs/mctpd.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -128,9 +128,9 @@ Similar to SetupEndpoint, but will always assign an EID rather than querying for
128128
existing ones. Will return `new = false` when an endpoint is already known to
129129
`mctpd`. If the endpoint is an MCTP bridge (indicated by requesting a pool size
130130
in its Set Endpoint ID response), this method attempts to allocate a contiguous
131-
range of EIDs for the bridge's downstream endpoints. If sufficient contiguous EIDs
132-
are not available within the dynamic allocation pool for the network, only the
133-
bridge's own EID will be assigned, and downstream EID allocation will fail.
131+
range of EIDs for the bridge's downstream endpoints. If sufficient contiguous
132+
EIDs are not available within the dynamic allocation pool for the network, only
133+
the bridge's own EID will be assigned, and downstream EID allocation will fail.
134134

135135
#### `.AssignEndpointStatic`: `ayy``yisb`
136136

@@ -220,19 +220,20 @@ busctl call au.com.codeconstruct.MCTP1 \
220220
Removes the MCTP endpoint from `mctpd`, and deletes routes and neighbour entries.
221221

222222
### MCTP bridge interface: `au.com.codeconstruct.MCTP.Bridge1` interface
223-
For any endpoint which also happens to be an MCTP Bridge, if dynamic eid is
224-
assgined to it via d-bus method `.AssignEndpoint`, such endpoint's pool
225-
allocation details would be reflected into `au.com.codeconstruct.MCTP.Bridge1`
226-
interface of bridge's endpoint object.
227223

228-
### `.PoolEnd`: `y`
224+
MCTP endpoints that are set up as a bridge device (and therefore have an
225+
EID pool allocated to them, for downstream devices) also carry the
226+
`MCTP.Bridge1` interface. This provides details of the allocated EID pool, via
227+
two properties:
228+
229+
### `.PoolStart`: `y`
229230

230-
A constant property representing last EID in the contiguous range allocated
231+
A constant property representing the first EID in the contiguous range allocated
231232
for downstream endpoints.
232233

233-
### `.PoolStart`: `y`
234+
### `.PoolEnd`: `y`
234235

235-
A constant property representing first EID in the contiguous range allocated
236+
A constant property representing the last EID in the contiguous range allocated
236237
for downstream endpoints.
237238

238239
## Configuration

0 commit comments

Comments
 (0)