platform/surface: aggregator: Improve documentation and handling of message target...
authorMaximilian Luz <luzmaximilian@gmail.com>
Fri, 2 Dec 2022 22:33:20 +0000 (23:33 +0100)
committerHans de Goede <hdegoede@redhat.com>
Thu, 2 Feb 2023 21:48:20 +0000 (22:48 +0100)
commit3f88b459a729ea397aa7cec9a7054a978882370a
treefdabe66e587d6da99e334264bc8c374dcb6c0aca
parent070b3098ddefdadcc6310878cf50ef09b380db1d
platform/surface: aggregator: Improve documentation and handling of message target and source IDs

The `tid_in` and `tid_out` fields of the serial hub protocol command
struct (struct ssh_command) are actually source and target IDs,
indicating the peer from which the message originated and the peer for
which it is intended.

Change the naming of those fields accordingly and improve the protocol
documentation. Additionally, introduce an enum containing all currently
known peers, i.e. targets and sources.

Signed-off-by: Maximilian Luz <luzmaximilian@gmail.com>
Link: https://lore.kernel.org/r/20221202223327.690880-3-luzmaximilian@gmail.com
Reviewed-by: Hans de Goede <hdegoede@redhat.com>
Signed-off-by: Hans de Goede <hdegoede@redhat.com>
Documentation/driver-api/surface_aggregator/client.rst
Documentation/driver-api/surface_aggregator/ssh.rst
drivers/platform/surface/aggregator/controller.c
drivers/platform/surface/aggregator/ssh_msgb.h
drivers/platform/surface/aggregator/ssh_request_layer.c
include/linux/surface_aggregator/controller.h
include/linux/surface_aggregator/serial_hub.h