docs/designs/pldm-stack.md

402 ### Terminus management and discovery
404 `pldmd` will maintain a terminus table to manage the PLDM terminus in system.
407 which is not in the terminus table yet. When the terminus EID is removed from
409 terminus table.
411 For each of terminus in the table, `pldmd` will go through the below steps:
413 - Terminus initialization
414 - Terminus discovery
415 - Terminus monitor and control
418 tasks of the terminus will be removed when it is removed from the terminus
421 #### Terminus initialization
423 Each terminus in PLDM interface is identified by terminus ID (TID). This TID is
424 an unique number `TID#`. When a new terminus is added to terminus table, `pldmd`
427 for the terminus.
429 Beside the `TID#`, terminus can also have `$TerminusName` or `$DeviceName` which
430 can be encoded in the Terminus's `Entity Auxiliary Names PDR` (section 28.18 of
434 Because the `$TerminusName` will be included in the Terminus' sensors, effecters
435 and states D-Bus object paths, so the EM EID configuration or Terminus's
436 `Entity Auxiliary Names PDR` are recommended to be included for the Terminus
439 have the terminus number `TID#` in it anyhow.
443 After the TID assignment steps, `pldmd` should go through `Terminus Discovery`
446 - Send `GetPLDMType` and `GetPLDMVersions` commands to the terminus to record
448 - If the terminus supports `GetPDRs` command type, `pldmd` will send that
449   command to get the terminus PDRs. Based on the retrieved PDRs, `pldmd` will
456   - The sensor/effecter/state info in the entities of terminus
469   Terminus's PDRs or the Terminus' EM JSON configuration files. This
473 - The `pldmd` then creates the Terminus inventory, sensors, effecters D-Bus
475 - At the final steps of `terminus discovery`, `pldmd` will send
477   messages from the terminus.
479 #### Terminus monitor and control
482 sensors, response for the events from terminus and handle the terminus control
487 To find out all sensors from PLDM terminus, `pldmd` should retrieve all the
494 terminus.
500 parse them as the same as the PDRs fetched by PLDM terminus.
508 the Terminus' `Entity Auxiliary name PDR` will provide `$TerminusName`. And
522 method depending on the capability of PLDM terminus.
526 failed to get the response from PLDM terminus or the completion code returned by
527 PLDM terminus is not `PLDM_SUCCESS`, the Functional property of
532 For each terminus, `pldmd` maintains a list to poll the Terminus' sensors and
534 interval to update the PLDM sensors of the terminus periodically. The PLDM
537 terminus' sensors will be read using `GetSensorReading` command. The read
548 terminus to identify if it can generate events. A PLDM sensor can work in event
549 aync method if the `updateInterval` of all sensors in the same PLDM terminus are
551 from PLDM terminus, `pldmd` should remove the sensor from poll list and then
553 to PLDM terminus for the initialization.
586 The APIs to parse PDRs from PLDM terminus can be tested by a mocking responder.