firmware: ti_sci: Fixup documentation errors
authorNishanth Menon <nm@ti.com>
Wed, 21 Jun 2023 02:16:19 +0000 (21:16 -0500)
committerNishanth Menon <nm@ti.com>
Tue, 11 Jul 2023 18:04:14 +0000 (13:04 -0500)
Fix up documentation errors, squashes the following warnings:
drivers/firmware/ti_sci.c:1986: warning: Excess function parameter 'vint_irq' description in 'ti_sci_cmd_set_irq'
drivers/firmware/ti_sci.c:2034: warning: Excess function parameter 'vint_irq' description in 'ti_sci_cmd_free_irq'
drivers/firmware/ti_sci.c:2630: warning: Function parameter or member 'bootvector' not described in 'ti_sci_cmd_proc_set_config'
drivers/firmware/ti_sci.c:2746: warning: Function parameter or member 'bv' not described in 'ti_sci_cmd_proc_get_status'
drivers/firmware/ti_sci.c:2746: warning: Function parameter or member 'cfg_flags' not described in 'ti_sci_cmd_proc_get_status'
drivers/firmware/ti_sci.c:2746: warning: Function parameter or member 'ctrl_flags' not described in 'ti_sci_cmd_proc_get_status'
drivers/firmware/ti_sci.c:2746: warning: Function parameter or member 'sts_flags' not described in 'ti_sci_cmd_proc_get_status'
drivers/firmware/ti_sci.c:2746: warning: expecting prototype for ti_sci_cmd_get_boot_status(). Prototype was for ti_sci_cmd_proc_get_status() instead
drivers/firmware/ti_sci.c:3265: warning: Function parameter or member 'sub_type' not described in 'devm_ti_sci_get_resource'
drivers/firmware/ti_sci.c:3265: warning: Excess function parameter 'suub_type' description in 'devm_ti_sci_get_resource'

Link: https://lore.kernel.org/r/20230621021619.265162-1-nm@ti.com
Signed-off-by: Nishanth Menon <nm@ti.com>
drivers/firmware/ti_sci.c

index 91aaa0ca9bde8698b0f6532a2b04a1aab3b38694..26a37f47f4ca5422a23e3774a9cd006ce81fed72 100644 (file)
@@ -1976,8 +1976,6 @@ static int ti_sci_free_irq(const struct ti_sci_handle *handle, u32 valid_params,
  * @src_index:         IRQ source index within the source device
  * @dst_id:            Device ID of the IRQ destination
  * @dst_host_irq:      IRQ number of the destination device
- * @vint_irq:          Boolean specifying if this interrupt belongs to
- *                     Interrupt Aggregator.
  *
  * Return: 0 if all went fine, else return appropriate error.
  */
@@ -2024,8 +2022,6 @@ static int ti_sci_cmd_set_event_map(const struct ti_sci_handle *handle,
  * @src_index:         IRQ source index within the source device
  * @dst_id:            Device ID of the IRQ destination
  * @dst_host_irq:      IRQ number of the destination device
- * @vint_irq:          Boolean specifying if this interrupt belongs to
- *                     Interrupt Aggregator.
  *
  * Return: 0 if all went fine, else return appropriate error.
  */
@@ -2618,6 +2614,7 @@ fail:
  *                                 configuration flags
  * @handle:            Pointer to TI SCI handle
  * @proc_id:           Processor ID this request is for
+ * @bootvector:                Processor Boot vector (start address)
  * @config_flags_set:  Configuration flags to be set
  * @config_flags_clear:        Configuration flags to be cleared.
  *
@@ -2734,9 +2731,13 @@ fail:
 }
 
 /**
- * ti_sci_cmd_get_boot_status() - Command to get the processor boot status
+ * ti_sci_cmd_proc_get_status() - Command to get the processor boot status
  * @handle:    Pointer to TI SCI handle
  * @proc_id:   Processor ID this request is for
+ * @bv:                Processor Boot vector (start address)
+ * @cfg_flags: Processor specific configuration flags
+ * @ctrl_flags:        Processor specific control flags
+ * @sts_flags: Processor specific status flags
  *
  * Return: 0 if all went well, else returns appropriate error value.
  */
@@ -3254,7 +3255,7 @@ EXPORT_SYMBOL_GPL(devm_ti_sci_get_of_resource);
  * @handle:    TISCI handle
  * @dev:       Device pointer to which the resource is assigned
  * @dev_id:    TISCI device id to which the resource is assigned
- * @suub_type: TISCI resource subytpe representing the resource.
+ * @sub_type:  TISCI resource subytpe representing the resource.
  *
  * Return: Pointer to ti_sci_resource if all went well else appropriate
  *        error pointer.