Unverified Commit 1a307538 authored by Peter Ujfalusi's avatar Peter Ujfalusi Committed by Mark Brown
Browse files

ASoC: SOF: ipc4: Add data struct for module notification message from firmware 



With the module notification message the information about the notification
is provided via the mailbox with the sof_ipc4_notify_module_data struct.

It contains the module and instance id of the sender of the notification,
the event_id and optionally additional data which is module and event
specific.

At the same time add definitions to identify ALSA kcontrol change
notification.
These notifications use standardized event_id, modules must follow this if
they support such notifications:
upper 16 bit: 0xA15A as a magic identification value
lower 16 bit: param_id of the changed control

Signed-off-by: default avatarPeter Ujfalusi <peter.ujfalusi@linux.intel.com>
Reviewed-by: default avatarRanjani Sridharan <ranjani.sridharan@linux.intel.com>
Reviewed-by: default avatarPierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
Link: https://lore.kernel.org/r/20231124150853.18648-3-peter.ujfalusi@linux.intel.com


Signed-off-by: default avatarMark Brown <broonie@kernel.org>
parent 5980bda0

include/sound/sof/ipc4/header.h

+29 −0
Original line number Diff line number Diff line
@@ -532,6 +532,35 @@ struct sof_ipc4_notify_resource_data { 
#define SOF_IPC4_DEBUG_SLOT_TELEMETRY		0x4c455400

#define SOF_IPC4_DEBUG_SLOT_BROKEN		0x44414544



/**

 * struct sof_ipc4_notify_module_data - payload for module notification

 * @instance_id: instance ID of the originator module of the notification

 * @module_id: module ID of the originator of the notification

 * @event_id: module specific event id

 * @event_data_size: Size of the @event_data (if any) in bytes

 * @event_data: Optional notification data, module and notification dependent

 */

struct sof_ipc4_notify_module_data {

	uint16_t instance_id;

	uint16_t module_id;

	uint32_t event_id;

	uint32_t event_data_size;

	uint8_t event_data[];

} __packed __aligned(4);



/*

 * ALSA kcontrol change notification

 *

 * The event_id of struct sof_ipc4_notify_module_data is divided into two u16:

 *  upper u16: magic number for ALSA kcontrol types: 0xA15A

 *  lower u16: param_id of the control, which is the type of the control

 * The event_data contains the struct sof_ipc4_control_msg_payload of the control

 * which sent the notification.

 */

#define SOF_IPC4_NOTIFY_MODULE_EVENTID_ALSA_MAGIC_MASK		GENMASK(31, 16)

#define SOF_IPC4_NOTIFY_MODULE_EVENTID_ALSA_MAGIC_VAL		0xA15A0000

#define SOF_IPC4_NOTIFY_MODULE_EVENTID_ALSA_PARAMID_MASK	GENMASK(15, 0)



/** @}*/



#endif