8d7792823d
Add documentation for the Surface Aggregator subsystem and its client drivers, giving an overview of the subsystem, its use-cases, its internal structure and internal API, as well as its external API for writing client drivers. Signed-off-by: Maximilian Luz <luzmaximilian@gmail.com> Reviewed-by: Hans de Goede <hdegoede@redhat.com> Link: https://lore.kernel.org/r/20201221183959.1186143-8-luzmaximilian@gmail.com Signed-off-by: Hans de Goede <hdegoede@redhat.com>
39 lines
839 B
ReStructuredText
39 lines
839 B
ReStructuredText
.. SPDX-License-Identifier: GPL-2.0+
|
|
|
|
===============================
|
|
Client Driver API Documentation
|
|
===============================
|
|
|
|
.. contents::
|
|
:depth: 2
|
|
|
|
|
|
Serial Hub Communication
|
|
========================
|
|
|
|
.. kernel-doc:: include/linux/surface_aggregator/serial_hub.h
|
|
|
|
.. kernel-doc:: drivers/platform/surface/aggregator/ssh_packet_layer.c
|
|
:export:
|
|
|
|
|
|
Controller and Core Interface
|
|
=============================
|
|
|
|
.. kernel-doc:: include/linux/surface_aggregator/controller.h
|
|
|
|
.. kernel-doc:: drivers/platform/surface/aggregator/controller.c
|
|
:export:
|
|
|
|
.. kernel-doc:: drivers/platform/surface/aggregator/core.c
|
|
:export:
|
|
|
|
|
|
Client Bus and Client Device API
|
|
================================
|
|
|
|
.. kernel-doc:: include/linux/surface_aggregator/device.h
|
|
|
|
.. kernel-doc:: drivers/platform/surface/aggregator/bus.c
|
|
:export:
|