0  h0 +lY>TD  r`S d@u_I|+?/* SPDX-License-Identifier: GPL-2.0+ */ /* * Surface System Aggregator Module (SSAM) controller interface. * * Main communication interface for the SSAM EC. Provides a controller * managing access and communication to and from the SSAM EC, as well as main * communication structures and definitions. * * Copyright (C) 2019-2021 Maximilian Luz */ #ifndef _LINUX_SURFACE_AGGREGATOR_CONTROLLER_H #define _LINUX_SURFACE_AGGREGATOR_CONTROLLER_H #include #include #include #include /* -- Main data types and definitions --------------------------------------- */ /** * enum ssam_event_flags - Flags for enabling/disabling SAM events * @SSAM_EVENT_SEQUENCED: The event will be sent via a sequenced data frame. */ enum ssam_event_flags { SSAM_EVENT_SEQUENCED = BIT(0), }; /** * struct ssam_event - SAM event sent from the EC to the host. * @target_category: Target category of the event source. See &enum ssam_ssh_tc. * @target_id: Target ID of the event source. * @command_id: Command ID of the event. * @instance_id: Instance ID of the event source. * @length: Length of the event payload in bytes. * @data: Event payload data. */ struct ssam_event { u8 target_category; u8 target_id; u8 command_id; u8 instance_id; u16 length; u8 data[]; }; /** * enum ssam_request_flags - Flags for SAM requests. * * @SSAM_REQUEST_HAS_RESPONSE: * Specifies that the request expects a response. If not set, the request * will be directly completed after its underlying packet has been * transmitted. If set, the request transport system waits for a response * of the request. * * @SSAM_REQUEST_UNSEQUENCED: * Specifies that the request should be transmitted via an unsequenced * packet. If set, the request must not have a response, meaning that this * flag and the %SSAM_REQUEST_HAS_RESPONSE flag are mutually exclusive. */ enum ssam_request_flags { SSAM_REQUEST_HAS_RESPONSE = BIT(0), SSAM_REQUEST_UNSEQUENCED = BIT(1), }; /** * struct ssam_request - SAM request description. * @target_category: Category of the request's target. See &enum ssam_ssh_tc. * @target_id: ID of the request's target. * @command_id: Command ID of the request. * @instance_id: Instance ID of the request's target. * @flags: Flags for the request. See &enum ssam_request_flags. * @length: Length of the request payload in bytes. * @payload: Request payload data. * * This struct fully describes a SAM request with payload. It is intended to * help set up the actual transport struct, e.g. &struct ssam_request_sync, * and specifically its raw message data via ssam_request_write_data(). */ struct ssam_request { u8 target_category; u8 target_id; u8 command_id; u8 instance_id; u16 flags; u16 length; const u8 *payload; }; /** * struct ssam_response - Response buffer for SAM request. * @capacity: Capacity of the buffer, in bytes. * @length: Length of the actual data stored in the memory pointed to by * @pointer, in bytes. Set by the transport system. * @pointer: Pointer to the buffer's memory, storing the response payload data. */ struct ssam_response { size_t capacity; size_t length; u8 *pointer; }; struct ssam_controller; struct ssam_controller *ssam_get_controller(void); struct ssam_controller *ssam_client_bind(struct device *client); int ssam_client_link(struct ssam_controller *ctrl, struct device *client); struct device *ssam_controller_device(struct ssam_controller *c); struct ssam_controller *ssam_controller_get(struct ssam_controller *c); void ssam_controller_put(struct ssam_controller *c); void ssam_controller_statelock(struct ssam_controller *c); void ssam_controller_stateunlock(struct ssam_controller *c); ssize_t ssam_request_write_data(struct ssam_span *buf, struct ssam_controller *ctrl, const struct ssam_reque