mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-10-01 14:44:12 +00:00
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>
67 lines
1.3 KiB
ReStructuredText
67 lines
1.3 KiB
ReStructuredText
.. SPDX-License-Identifier: GPL-2.0+
|
|
|
|
==========================
|
|
Internal API Documentation
|
|
==========================
|
|
|
|
.. contents::
|
|
:depth: 2
|
|
|
|
|
|
Packet Transport Layer
|
|
======================
|
|
|
|
.. kernel-doc:: drivers/platform/surface/aggregator/ssh_parser.h
|
|
:internal:
|
|
|
|
.. kernel-doc:: drivers/platform/surface/aggregator/ssh_parser.c
|
|
:internal:
|
|
|
|
.. kernel-doc:: drivers/platform/surface/aggregator/ssh_msgb.h
|
|
:internal:
|
|
|
|
.. kernel-doc:: drivers/platform/surface/aggregator/ssh_packet_layer.h
|
|
:internal:
|
|
|
|
.. kernel-doc:: drivers/platform/surface/aggregator/ssh_packet_layer.c
|
|
:internal:
|
|
|
|
|
|
Request Transport Layer
|
|
=======================
|
|
|
|
.. kernel-doc:: drivers/platform/surface/aggregator/ssh_request_layer.h
|
|
:internal:
|
|
|
|
.. kernel-doc:: drivers/platform/surface/aggregator/ssh_request_layer.c
|
|
:internal:
|
|
|
|
|
|
Controller
|
|
==========
|
|
|
|
.. kernel-doc:: drivers/platform/surface/aggregator/controller.h
|
|
:internal:
|
|
|
|
.. kernel-doc:: drivers/platform/surface/aggregator/controller.c
|
|
:internal:
|
|
|
|
|
|
Client Device Bus
|
|
=================
|
|
|
|
.. kernel-doc:: drivers/platform/surface/aggregator/bus.c
|
|
:internal:
|
|
|
|
|
|
Core
|
|
====
|
|
|
|
.. kernel-doc:: drivers/platform/surface/aggregator/core.c
|
|
:internal:
|
|
|
|
|
|
Trace Helpers
|
|
=============
|
|
|
|
.. kernel-doc:: drivers/platform/surface/aggregator/trace.h
|