ASoC: SOF: sof-priv: Mark fw_tracing ops optional in documentation
authorPeter Ujfalusi <peter.ujfalusi@linux.intel.com>
Wed, 21 Dec 2022 10:23:26 +0000 (12:23 +0200)
committerMark Brown <broonie@kernel.org>
Sun, 25 Dec 2022 23:32:37 +0000 (23:32 +0000)
The code treats the fw_tracing as optional feature but the documentation
was not reflecting this.
Correct it by explicitly stating that the fw_tracing is optional.

Signed-off-by: Peter Ujfalusi <peter.ujfalusi@linux.intel.com>
Reviewed-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
Reviewed-by: Ranjani Sridharan <ranjani.sridharan@linux.intel.com>
Reviewed-by: Bard Liao <yung-chuan.liao@linux.intel.com>
Reviewed-by: Rander Wang <rander.wang@intel.com>
Link: https://lore.kernel.org/r/20221221102328.9635-10-peter.ujfalusi@linux.intel.com
Signed-off-by: Mark Brown <broonie@kernel.org>
sound/soc/sof/sof-priv.h

index 144906c..752bf46 100644 (file)
@@ -444,7 +444,7 @@ struct sof_ipc_pcm_ops;
  * @pm:                Pointer to PM ops
  * @pcm:       Pointer to PCM ops
  * @fw_loader: Pointer to Firmware Loader ops
- * @fw_tracing:        Pointer to Firmware tracing ops
+ * @fw_tracing:        Optional pointer to Firmware tracing ops
  *
  * @init:      Optional pointer for IPC related initialization
  * @exit:      Optional pointer for IPC related cleanup