diff mbox series

drm/i915/gt: Remove stale kerneldoc for internal MOCS functions

Message ID 20190803102221.21344-1-chris@chris-wilson.co.uk (mailing list archive)
State New, archived
Headers show
Series drm/i915/gt: Remove stale kerneldoc for internal MOCS functions | expand

Commit Message

Chris Wilson Aug. 3, 2019, 10:22 a.m. UTC
The kerneldoc were stale, generating mismatching parameters warning, but
furthermore they were for internal routines, not part of the MOCS
interface so the instructions were superfluous.

Signed-off-by: Chris Wilson <chris@chris-wilson.co.uk>
---
 drivers/gpu/drm/i915/gt/intel_mocs.c | 57 +---------------------------
 1 file changed, 2 insertions(+), 55 deletions(-)

Comments

Daniele Ceraolo Spurio Aug. 5, 2019, 4:59 p.m. UTC | #1
On 8/3/19 3:22 AM, Chris Wilson wrote:
> The kerneldoc were stale, generating mismatching parameters warning, but
> furthermore they were for internal routines, not part of the MOCS
> interface so the instructions were superfluous.
> 
> Signed-off-by: Chris Wilson <chris@chris-wilson.co.uk>

Reviewed-by: Daniele Ceraolo Spurio <daniele.ceraolospurio@intel.com>

Has adding kerneldoc generation to CI been considered?

Daniele

> ---
>   drivers/gpu/drm/i915/gt/intel_mocs.c | 57 +---------------------------
>   1 file changed, 2 insertions(+), 55 deletions(-)
> 
> diff --git a/drivers/gpu/drm/i915/gt/intel_mocs.c b/drivers/gpu/drm/i915/gt/intel_mocs.c
> index 77ddb307346a..728704bbbe18 100644
> --- a/drivers/gpu/drm/i915/gt/intel_mocs.c
> +++ b/drivers/gpu/drm/i915/gt/intel_mocs.c
> @@ -287,18 +287,6 @@ static const struct drm_i915_mocs_entry icelake_mocs_table[] = {
>   	GEN11_MOCS_ENTRIES
>   };
>   
> -/**
> - * get_mocs_settings()
> - * @gt:		gt device
> - * @table:      Output table that will be made to point at appropriate
> - *	      MOCS values for the device.
> - *
> - * This function will return the values of the MOCS table that needs to
> - * be programmed for the platform. It will return the values that need
> - * to be programmed and if they need to be programmed.
> - *
> - * Return: true if there are applicable MOCS settings for the device.
> - */
>   static bool get_mocs_settings(struct intel_gt *gt,
>   			      struct drm_i915_mocs_table *table)
>   {
> @@ -420,12 +408,6 @@ void intel_mocs_init_engine(struct intel_engine_cs *engine)
>   				      unused_value);
>   }
>   
> -/**
> - * intel_mocs_init_global() - program the global mocs registers
> - * gt:      pointer to struct intel_gt
> - *
> - * This function initializes the MOCS global registers.
> - */
>   static void intel_mocs_init_global(struct intel_gt *gt)
>   {
>   	struct intel_uncore *uncore = gt->uncore;
> @@ -456,16 +438,6 @@ static void intel_mocs_init_global(struct intel_gt *gt)
>   				   table.table[0].control_value);
>   }
>   
> -/**
> - * emit_mocs_control_table() - emit the mocs control table
> - * @rq:	Request to set up the MOCS table for.
> - * @table:	The values to program into the control regs.
> - *
> - * This function simply emits a MI_LOAD_REGISTER_IMM command for the
> - * given table starting at the given address.
> - *
> - * Return: 0 on success, otherwise the error status.
> - */
>   static int emit_mocs_control_table(struct i915_request *rq,
>   				   const struct drm_i915_mocs_table *table)
>   {
> @@ -525,17 +497,6 @@ static inline u32 l3cc_combine(const struct drm_i915_mocs_table *table,
>   	return low | high << 16;
>   }
>   
> -/**
> - * emit_mocs_l3cc_table() - emit the mocs control table
> - * @rq:	Request to set up the MOCS table for.
> - * @table:	The values to program into the control regs.
> - *
> - * This function simply emits a MI_LOAD_REGISTER_IMM command for the
> - * given table starting at the given address. This register set is
> - * programmed in pairs.
> - *
> - * Return: 0 on success, otherwise the error status.
> - */
>   static int emit_mocs_l3cc_table(struct i915_request *rq,
>   				const struct drm_i915_mocs_table *table)
>   {
> @@ -584,20 +545,6 @@ static int emit_mocs_l3cc_table(struct i915_request *rq,
>   	return 0;
>   }
>   
> -/**
> - * intel_mocs_init_l3cc_table() - program the mocs control table
> - * @gt: the intel_gt container
> - *
> - * This function simply programs the mocs registers for the given table
> - * starting at the given address. This register set is  programmed in pairs.
> - *
> - * These registers may get programmed more than once, it is simpler to
> - * re-program 32 registers than maintain the state of when they were programmed.
> - * We are always reprogramming with the same values and this only on context
> - * start.
> - *
> - * Return: Nothing.
> - */
>   static void intel_mocs_init_l3cc_table(struct intel_gt *gt)
>   {
>   	struct intel_uncore *uncore = gt->uncore;
> @@ -639,8 +586,8 @@ static void intel_mocs_init_l3cc_table(struct intel_gt *gt)
>   }
>   
>   /**
> - * intel_rcs_context_init_mocs() - program the MOCS register.
> - * @rq:	Request to set up the MOCS tables for.
> + * intel_mocs_emit() - program the MOCS register.
> + * @rq:	Request to use to set up the MOCS tables.
>    *
>    * This function will emit a batch buffer with the values required for
>    * programming the MOCS register values for all the currently supported
>
Chris Wilson Aug. 5, 2019, 5:26 p.m. UTC | #2
Quoting Daniele Ceraolo Spurio (2019-08-05 17:59:31)
> 
> 
> On 8/3/19 3:22 AM, Chris Wilson wrote:
> > The kerneldoc were stale, generating mismatching parameters warning, but
> > furthermore they were for internal routines, not part of the MOCS
> > interface so the instructions were superfluous.
> > 
> > Signed-off-by: Chris Wilson <chris@chris-wilson.co.uk>
> 
> Reviewed-by: Daniele Ceraolo Spurio <daniele.ceraolospurio@intel.com>
> 
> Has adding kerneldoc generation to CI been considered?

The parameters get checked by make W=1, so it's not beyond our means to
include the warnings in the compile check...
-Chris
diff mbox series

Patch

diff --git a/drivers/gpu/drm/i915/gt/intel_mocs.c b/drivers/gpu/drm/i915/gt/intel_mocs.c
index 77ddb307346a..728704bbbe18 100644
--- a/drivers/gpu/drm/i915/gt/intel_mocs.c
+++ b/drivers/gpu/drm/i915/gt/intel_mocs.c
@@ -287,18 +287,6 @@  static const struct drm_i915_mocs_entry icelake_mocs_table[] = {
 	GEN11_MOCS_ENTRIES
 };
 
-/**
- * get_mocs_settings()
- * @gt:		gt device
- * @table:      Output table that will be made to point at appropriate
- *	      MOCS values for the device.
- *
- * This function will return the values of the MOCS table that needs to
- * be programmed for the platform. It will return the values that need
- * to be programmed and if they need to be programmed.
- *
- * Return: true if there are applicable MOCS settings for the device.
- */
 static bool get_mocs_settings(struct intel_gt *gt,
 			      struct drm_i915_mocs_table *table)
 {
@@ -420,12 +408,6 @@  void intel_mocs_init_engine(struct intel_engine_cs *engine)
 				      unused_value);
 }
 
-/**
- * intel_mocs_init_global() - program the global mocs registers
- * gt:      pointer to struct intel_gt
- *
- * This function initializes the MOCS global registers.
- */
 static void intel_mocs_init_global(struct intel_gt *gt)
 {
 	struct intel_uncore *uncore = gt->uncore;
@@ -456,16 +438,6 @@  static void intel_mocs_init_global(struct intel_gt *gt)
 				   table.table[0].control_value);
 }
 
-/**
- * emit_mocs_control_table() - emit the mocs control table
- * @rq:	Request to set up the MOCS table for.
- * @table:	The values to program into the control regs.
- *
- * This function simply emits a MI_LOAD_REGISTER_IMM command for the
- * given table starting at the given address.
- *
- * Return: 0 on success, otherwise the error status.
- */
 static int emit_mocs_control_table(struct i915_request *rq,
 				   const struct drm_i915_mocs_table *table)
 {
@@ -525,17 +497,6 @@  static inline u32 l3cc_combine(const struct drm_i915_mocs_table *table,
 	return low | high << 16;
 }
 
-/**
- * emit_mocs_l3cc_table() - emit the mocs control table
- * @rq:	Request to set up the MOCS table for.
- * @table:	The values to program into the control regs.
- *
- * This function simply emits a MI_LOAD_REGISTER_IMM command for the
- * given table starting at the given address. This register set is
- * programmed in pairs.
- *
- * Return: 0 on success, otherwise the error status.
- */
 static int emit_mocs_l3cc_table(struct i915_request *rq,
 				const struct drm_i915_mocs_table *table)
 {
@@ -584,20 +545,6 @@  static int emit_mocs_l3cc_table(struct i915_request *rq,
 	return 0;
 }
 
-/**
- * intel_mocs_init_l3cc_table() - program the mocs control table
- * @gt: the intel_gt container
- *
- * This function simply programs the mocs registers for the given table
- * starting at the given address. This register set is  programmed in pairs.
- *
- * These registers may get programmed more than once, it is simpler to
- * re-program 32 registers than maintain the state of when they were programmed.
- * We are always reprogramming with the same values and this only on context
- * start.
- *
- * Return: Nothing.
- */
 static void intel_mocs_init_l3cc_table(struct intel_gt *gt)
 {
 	struct intel_uncore *uncore = gt->uncore;
@@ -639,8 +586,8 @@  static void intel_mocs_init_l3cc_table(struct intel_gt *gt)
 }
 
 /**
- * intel_rcs_context_init_mocs() - program the MOCS register.
- * @rq:	Request to set up the MOCS tables for.
+ * intel_mocs_emit() - program the MOCS register.
+ * @rq:	Request to use to set up the MOCS tables.
  *
  * This function will emit a batch buffer with the values required for
  * programming the MOCS register values for all the currently supported