Skip to contentSkip to conversation

media: atomisp: Codingstyle

PATCH Superseded Philipp Gerlesberger 2 participants 15 messages Dec 7, 2020 – Dec 8, 2020

Subsystems (4)

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

cover media: atomisp: Codingstyle

Hello!

This series fix some codingstyle errors in the files rmgr_vbuf.c, ia_css_rmgr.h, timer.c, spctrl.c and queue.c in the drivers/staging/media area.

Best regards
Philipp

----------------------------------------------------------------------
media: atomsip: Convert comments to C99 initializers
media: atomisp: Fix Block Comments
media: atomisp: Fix EMBEDDED_FUNCTION_NAME warning
media: atomisp: Fix OPEN_ENDED_LINE
media: atomisp: Fix overlong line
media: atomisp: Add parentheses
media: atomisp: Fix funciton decleration
media: atomisp: Delete braces
media: atomisp: Fix PARENTHESIS_ALIGNMENT
media: atomisp: Fix BLOCK_COMMENT_STYLE
media: atomisp: Write function decleration in one line
media: atomisp: Fix LOGICAL_CONTINUATIONS

 .../atomisp/pci/runtime/queue/src/queue.c     | 48 +++++-------------
 .../pci/runtime/rmgr/interface/ia_css_rmgr.h  |  4 +-
 .../atomisp/pci/runtime/rmgr/src/rmgr_vbuf.c  | 49 +++++++++----------
 .../atomisp/pci/runtime/spctrl/src/spctrl.c   |  7 ++-
 .../atomisp/pci/runtime/timer/src/timer.c     |  7 +--
 5 files changed, 44 insertions(+), 71 deletions(-)
Signature · 1 line
2.20.1
#1 lore raw

PATCH 1/12 media: atomsip: Convert comments to C99 initializers

The struct initalizers have been changed as recommended on
https://kernelnewbies.org/KernelJanitors/Todo

---
 .../atomisp/pci/runtime/rmgr/src/rmgr_vbuf.c  | 30 +++++++++----------
 1 file changed, 15 insertions(+), 15 deletions(-)
drivers/staging/media/atomisp/pci/runtime/rmgr/src/rmgr_vbuf.c +15 -15
index b4f53be18e7f..af61d05e88d3 100644
@@ -31,33 +31,33 @@ static struct ia_css_rmgr_vbuf_handle handle_table[NUM_HANDLES];
  * @brief VBUF resource pool - refpool
  */
 static struct ia_css_rmgr_vbuf_pool refpool = {
-	false,			/* copy_on_write */
-	false,			/* recycle */
-	0,			/* size */
-	0,			/* index */
-	NULL,			/* handles */
+	.copy_on_write	= false,
+	.recycle	= false,
+	.size		= 0,
+	.index		= 0,
+	.handles	= NULL,
 };
 
 /*
  * @brief VBUF resource pool - writepool
  */
 static struct ia_css_rmgr_vbuf_pool writepool = {
-	true,			/* copy_on_write */
-	false,			/* recycle */
-	0,			/* size */
-	0,			/* index */
-	NULL,			/* handles */
+	.copy_on_write	= true,
+	.recycle	= false,
+	.size		= 0,
+	.index		= 0,
+	.handles	= NULL,
 };
 
 /*
  * @brief VBUF resource pool - hmmbufferpool
  */
 static struct ia_css_rmgr_vbuf_pool hmmbufferpool = {
-	true,			/* copy_on_write */
-	true,			/* recycle */
-	32,			/* size */
-	0,			/* index */
-	NULL,			/* handles */
+	.copy_on_write	= true,
+	.recycle	= true,
+	.size		= 32,
+	.index		= 0,
+	.handles	= NULL,
 };
 
 struct ia_css_rmgr_vbuf_pool *vbuf_ref = &refpool;
Signature · 1 line
2.20.1
#2 lore raw

Re: [PATCH 01/12] media: atomsip: Convert comments to C99 initializers

Quoted 18 lines · Philipp Gerlesberger

The struct initalizers have been changed as recommended on
https://kernelnewbies.org/KernelJanitors/Todo

---
 .../atomisp/pci/runtime/rmgr/src/rmgr_vbuf.c  | 30 +++++++++----------
 1 file changed, 15 insertions(+), 15 deletions(-)
drivers/staging/media/atomisp/pci/runtime/rmgr/src/rmgr_vbuf.c +0 -0
index b4f53be18e7f..af61d05e88d3 100644
@@ -31,33 +31,33 @@ static struct ia_css_rmgr_vbuf_handle handle_table[NUM_HANDLES];
  * @brief VBUF resource pool - refpool
  */
 static struct ia_css_rmgr_vbuf_pool refpool = {

drivers/staging/media/atomisp/pci/runtime/rmgr/src/rmgr_vbuf.c static struct ia_css_rmgr_vbuf_handle handle_table[NUM_HANDLES]; · line 38

Quoted 10 lines
drivers/staging/media/atomisp/pci/runtime/rmgr/src/rmgr_vbuf.c +5 -5
-	false,			/* copy_on_write */
-	false,			/* recycle */
-	0,			/* size */
-	0,			/* index */
-	NULL,			/* handles */
+	.copy_on_write	= false,
+	.recycle	= false,
+	.size		= 0,
+	.index		= 0,
+	.handles	= NULL,

If you're using C99 initializers then you can remove all the false, 0 and NULL members.

regards,
dan carpenter

#3 lore raw

PATCH 2/12 media: atomisp: Fix Block Comments

In reply to Philipp Gerlesberger

Block comments should use * on subsequent lines and should use a trailing */ on a separate line.

---
 .../staging/media/atomisp/pci/runtime/rmgr/src/rmgr_vbuf.c   | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
drivers/staging/media/atomisp/pci/runtime/rmgr/src/rmgr_vbuf.c +3 -2
index af61d05e88d3..4ba5b8f88a7d 100644
@@ -98,7 +98,7 @@ void ia_css_rmgr_refcount_retain_vbuf(struct ia_css_rmgr_vbuf_handle **handle)
 			}
 		}
 		/* if the loop dus not break and *handle == NULL
-		   this is an error handle and report it.
+		 * this is an error handle and report it.
 		 */
 		if (!*handle) {
 			ia_css_debug_dtrace(IA_CSS_DEBUG_ERROR,
@@ -253,7 +253,8 @@ void rmgr_pop_handle(struct ia_css_rmgr_vbuf_pool *pool,
 			*handle = pool->handles[i];
 			pool->handles[i] = NULL;
 			/* dont release, we are returning it...
-			   ia_css_rmgr_refcount_release_vbuf(handle); */
+			 * ia_css_rmgr_refcount_release_vbuf(handle);
+			 */
 			return;
 		}
 	}
Signature · 1 line
2.20.1
#4 lore raw

PATCH 3/12 media: atomisp: Fix EMBEDDED_FUNCTION_NAME warning

In reply to Philipp Gerlesberger

Use the automatically defined __func__ macro instead of the function name, so it stays correct when the function is renamed.

---
 .../media/atomisp/pci/runtime/rmgr/src/rmgr_vbuf.c        | 8 +++-----
 1 file changed, 3 insertions(+), 5 deletions(-)
drivers/staging/media/atomisp/pci/runtime/rmgr/src/rmgr_vbuf.c +3 -5
index 4ba5b8f88a7d..3fb3c8c48f0b 100644
@@ -119,8 +119,7 @@ void ia_css_rmgr_refcount_retain_vbuf(struct ia_css_rmgr_vbuf_handle **handle)
 void ia_css_rmgr_refcount_release_vbuf(struct ia_css_rmgr_vbuf_handle **handle)
 {
 	if ((!handle) || ((*handle) == NULL) || (((*handle)->count) == 0)) {
-		ia_css_debug_dtrace(IA_CSS_DEBUG_ERROR,
-				    "ia_css_rmgr_refcount_release_vbuf() invalid arguments!\n");
+		ia_css_debug_dtrace(IA_CSS_DEBUG_ERROR, "%s invalid arguments!\n", __func__);
 		return;
 	}
 	/* decrease reference count */
@@ -175,10 +174,9 @@ void ia_css_rmgr_uninit_vbuf(struct ia_css_rmgr_vbuf_pool *pool)
 {
 	u32 i;
 
-	ia_css_debug_dtrace(IA_CSS_DEBUG_TRACE, "ia_css_rmgr_uninit_vbuf()\n");
+	ia_css_debug_dtrace(IA_CSS_DEBUG_TRACE, "%s\n", __func__);
 	if (!pool) {
-		ia_css_debug_dtrace(IA_CSS_DEBUG_ERROR,
-				    "ia_css_rmgr_uninit_vbuf(): NULL argument\n");
+		ia_css_debug_dtrace(IA_CSS_DEBUG_ERROR, "%s NULL argument\n", __func__);
 		return;
 	}
 	if (pool->handles) {
Signature · 1 line
2.20.1
#5 lore raw

PATCH 4/12 media: atomisp: Fix OPEN_ENDED_LINE

In reply to Philipp Gerlesberger

Lines should not end with a '('

---
 drivers/staging/media/atomisp/pci/runtime/rmgr/src/rmgr_vbuf.c | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)
drivers/staging/media/atomisp/pci/runtime/rmgr/src/rmgr_vbuf.c +1 -2
index 3fb3c8c48f0b..e4483d41ec7a 100644
@@ -190,8 +190,7 @@ void ia_css_rmgr_uninit_vbuf(struct ia_css_rmgr_vbuf_pool *pool)
 				/* free memory */
 				hmm_free(pool->handles[i]->vptr);
 				/* remove from refcount admin */
-				ia_css_rmgr_refcount_release_vbuf(
-				    &pool->handles[i]);
+				ia_css_rmgr_refcount_release_vbuf(&pool->handles[i]);
 			}
 		}
 		/* now free the pool handles list */
Signature · 1 line
2.20.1
#6 lore raw

PATCH 5/12 media: atomisp: Fix overlong line

In reply to Philipp Gerlesberger

Line length of 105 exceeds 100 columns.

---
 drivers/staging/media/atomisp/pci/runtime/rmgr/src/rmgr_vbuf.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
drivers/staging/media/atomisp/pci/runtime/rmgr/src/rmgr_vbuf.c +2 -1
index e4483d41ec7a..e4ce8bbacd54 100644
@@ -294,7 +294,8 @@ void ia_css_rmgr_acq_vbuf(struct ia_css_rmgr_vbuf_pool *pool,
 			}
 			if ((*handle)->vptr == 0x0) {
 				/* we need to allocate */
-				(*handle)->vptr = hmm_alloc((*handle)->size, HMM_BO_PRIVATE, 0, NULL, 0);
+				(*handle)->vptr = hmm_alloc((*handle)->size,
+							     HMM_BO_PRIVATE, 0, NULL, 0);
 			} else {
 				/* we popped a buffer */
 				return;
Signature · 1 line
2.20.1
#7 lore raw

PATCH 6/12 media: atomisp: Add parentheses

In reply to Philipp Gerlesberger

ERROR:COMPLEX_MACRO: Macros with complex values should be enclosed in parentheses

---
 .../media/atomisp/pci/runtime/rmgr/interface/ia_css_rmgr.h    | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/staging/media/atomisp/pci/runtime/rmgr/interface/ia_css_rmgr.h +2 -2
index 9cd3d92b34c9..2c02dd1cf27a 100644
@@ -22,8 +22,8 @@
 #define STORAGE_CLASS_RMGR_H extern
 #define STORAGE_CLASS_RMGR_C
 #else				/* __INLINE_RMGR__ */
-#define STORAGE_CLASS_RMGR_H static inline
-#define STORAGE_CLASS_RMGR_C static inline
+#define STORAGE_CLASS_RMGR_H (static inline)
+#define STORAGE_CLASS_RMGR_C (static inline)
 #endif				/* __INLINE_RMGR__ */
 
 /**
Signature · 1 line
2.20.1
#8 lore raw

Re: [PATCH 06/12] media: atomisp: Add parentheses

Quoted 15 lines · Philipp Gerlesberger

ERROR:COMPLEX_MACRO: Macros with complex values should be enclosed in parentheses

---
 .../media/atomisp/pci/runtime/rmgr/interface/ia_css_rmgr.h    | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/staging/media/atomisp/pci/runtime/rmgr/interface/ia_css_rmgr.h +0 -0
index 9cd3d92b34c9..2c02dd1cf27a 100644

drivers/staging/media/atomisp/pci/runtime/rmgr/interface/ia_css_rmgr.h line 26

Quoted 7 lines
drivers/staging/media/atomisp/pci/runtime/rmgr/interface/ia_css_rmgr.h +2 -2
@@ -22,8 +22,8 @@
 #define STORAGE_CLASS_RMGR_H extern
 #define STORAGE_CLASS_RMGR_C
 #else				/* __INLINE_RMGR__ */
-#define STORAGE_CLASS_RMGR_H static inline
-#define STORAGE_CLASS_RMGR_C static inline
+#define STORAGE_CLASS_RMGR_H (static inline)
+#define STORAGE_CLASS_RMGR_C (static inline)

This will break the build.

You should just remove these defines. They don't make any sort of sense. The programmer should know what things need to be static and what not. Generally leave "inline" out, and let the compiler decide. If you have a legit reason to think you are smarter than the compiler (benchmarking data) then probably __always_inline is more appropriate.

regards,
dan carpenter

#9 lore raw

PATCH 7/12 media: atomisp: Fix funciton decleration

In reply to Philipp Gerlesberger

Write return_type, function_name and parameters in one line because lines should not end with a '(' [OPEN_ENDED_LINE] Write open brace ’{’ on the next line to fix OPEN_BRACE Error

---
 drivers/staging/media/atomisp/pci/runtime/timer/src/timer.c | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)
drivers/staging/media/atomisp/pci/runtime/timer/src/timer.c +2 -3
index 679ef8242574..00b54a0613bb 100644
@@ -19,9 +19,8 @@
 #include "gp_timer.h" /*gp_timer_read()*/
 #include "assert_support.h"
 
-int
-ia_css_timer_get_current_tick(
-    struct ia_css_clock_tick *curr_ts) {
+int ia_css_timer_get_current_tick(struct ia_css_clock_tick *curr_ts)
+{
 	assert(curr_ts);
 	if (!curr_ts)
 	{
Signature · 1 line
2.20.1
#10 lore raw

PATCH 8/12 media: atomisp: Delete braces

In reply to Philipp Gerlesberger

WARNING:BRACES: braces {} are not necessary for single statement blocks

---
 drivers/staging/media/atomisp/pci/runtime/timer/src/timer.c | 2 --
 1 file changed, 2 deletions(-)
drivers/staging/media/atomisp/pci/runtime/timer/src/timer.c +0 -2
index 00b54a0613bb..08f5c3ea6d29 100644
@@ -23,9 +23,7 @@ int ia_css_timer_get_current_tick(struct ia_css_clock_tick *curr_ts)
 {
 	assert(curr_ts);
 	if (!curr_ts)
-	{
 		return -EINVAL;
-	}
 	curr_ts->ticks = (clock_value_t)gp_timer_read(GP_TIMER_SEL);
 	return 0;
 }
Signature · 1 line
2.20.1
#11 lore raw

PATCH 9/12 media: atomisp: Fix PARENTHESIS_ALIGNMENT

In reply to Philipp Gerlesberger

You can sum up the two lines, because the maximum line length of 100 columns is not exceeded.

---
 drivers/staging/media/atomisp/pci/runtime/spctrl/src/spctrl.c | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)
drivers/staging/media/atomisp/pci/runtime/spctrl/src/spctrl.c +1 -2
index 753a99703f1e..38f86764ccfc 100644
@@ -37,8 +37,7 @@ static struct spctrl_context_info spctrl_cofig_info[N_SP_ID];
 static bool spctrl_loaded[N_SP_ID] = {0};
 
 /* Load firmware */
-int ia_css_spctrl_load_fw(sp_ID_t sp_id,
-				      ia_css_spctrl_cfg *spctrl_cfg)
+int ia_css_spctrl_load_fw(sp_ID_t sp_id, ia_css_spctrl_cfg *spctrl_cfg)
 {
 	ia_css_ptr code_addr = mmgr_NULL;
 	struct ia_css_sp_init_dmem_cfg *init_dmem_cfg;
Signature · 1 line
2.20.1
#12 lore raw

PATCH 10/12 media: atomisp: Fix BLOCK_COMMENT_STYLE

In reply to Philipp Gerlesberger

Block comments should align the * on each line

---
 drivers/staging/media/atomisp/pci/runtime/spctrl/src/spctrl.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/staging/media/atomisp/pci/runtime/spctrl/src/spctrl.c +2 -2
index 38f86764ccfc..7f4592565af6 100644
@@ -105,8 +105,8 @@ int ia_css_spctrl_load_fw(sp_ID_t sp_id, ia_css_spctrl_cfg *spctrl_cfg)
 void sh_css_spctrl_reload_fw(sp_ID_t sp_id)
 {
 	/* now we program the base address into the icache and
-	* invalidate the cache.
-	*/
+	 * invalidate the cache.
+	 */
 	sp_ctrl_store(sp_id, SP_ICACHE_ADDR_REG,
 		      (hrt_data)spctrl_cofig_info[sp_id].code_addr);
 	sp_ctrl_setbit(sp_id, SP_ICACHE_INV_REG, SP_ICACHE_INV_BIT);
Signature · 1 line
2.20.1
#13 lore raw

PATCH 11/12 media: atomisp: Write function decleration in one line

In reply to Philipp Gerlesberger

CHECK:OPEN_ENDED_LINE: Lines should not end with a '(' WARNING:LEADING_SPACE: please, no spaces at the start of a line Avoid these errors by writing the function decleration in one line.

---
 .../atomisp/pci/runtime/queue/src/queue.c     | 44 +++++--------------
 1 file changed, 11 insertions(+), 33 deletions(-)
drivers/staging/media/atomisp/pci/runtime/queue/src/queue.c +11 -33
index aea6c66a3cee..2f1c2df59f71 100644
@@ -22,9 +22,7 @@
 /*****************************************************************************
  * Queue Public APIs
  *****************************************************************************/
-int ia_css_queue_local_init(
-    ia_css_queue_t *qhandle,
-    ia_css_queue_local_t *desc)
+int ia_css_queue_local_init(ia_css_queue_t *qhandle, ia_css_queue_local_t *desc)
 {
 	if (NULL == qhandle || NULL == desc
 	    || NULL == desc->cb_elems || NULL == desc->cb_desc) {
@@ -43,9 +41,7 @@ int ia_css_queue_local_init(
 	return 0;
 }
 
-int ia_css_queue_remote_init(
-    ia_css_queue_t *qhandle,
-    ia_css_queue_remote_t *desc)
+int ia_css_queue_remote_init(ia_css_queue_t *qhandle, ia_css_queue_remote_t *desc)
 {
 	if (NULL == qhandle || NULL == desc) {
 		/* Invalid parameters, return error*/
@@ -69,8 +65,7 @@ int ia_css_queue_remote_init(
 	return 0;
 }
 
-int ia_css_queue_uninit(
-    ia_css_queue_t *qhandle)
+int ia_css_queue_uninit(ia_css_queue_t *qhandle)
 {
 	if (!qhandle)
 		return -EINVAL;
@@ -84,9 +79,7 @@ int ia_css_queue_uninit(
 	return 0;
 }
 
-int ia_css_queue_enqueue(
-    ia_css_queue_t *qhandle,
-    uint32_t item)
+int ia_css_queue_enqueue(ia_css_queue_t *qhandle, uint32_t item)
 {
 	int error = 0;
 
@@ -143,9 +136,7 @@ int ia_css_queue_enqueue(
 	return 0;
 }
 
-int ia_css_queue_dequeue(
-    ia_css_queue_t *qhandle,
-    uint32_t *item)
+int ia_css_queue_dequeue(ia_css_queue_t *qhandle, uint32_t *item)
 {
 	int error = 0;
 
@@ -200,9 +191,7 @@ int ia_css_queue_dequeue(
 	return 0;
 }
 
-int ia_css_queue_is_full(
-    ia_css_queue_t *qhandle,
-    bool *is_full)
+int ia_css_queue_is_full(ia_css_queue_t *qhandle, bool *is_full)
 {
 	int error = 0;
 
@@ -234,9 +223,7 @@ int ia_css_queue_is_full(
 	return -EINVAL;
 }
 
-int ia_css_queue_get_free_space(
-    ia_css_queue_t *qhandle,
-    uint32_t *size)
+int ia_css_queue_get_free_space(ia_css_queue_t *qhandle, uint32_t *size)
 {
 	int error = 0;
 
@@ -268,9 +255,7 @@ int ia_css_queue_get_free_space(
 	return -EINVAL;
 }
 
-int ia_css_queue_get_used_space(
-    ia_css_queue_t *qhandle,
-    uint32_t *size)
+int ia_css_queue_get_used_space(ia_css_queue_t *qhandle, uint32_t *size)
 {
 	int error = 0;
 
@@ -302,10 +287,7 @@ int ia_css_queue_get_used_space(
 	return -EINVAL;
 }
 
-int ia_css_queue_peek(
-    ia_css_queue_t *qhandle,
-    u32 offset,
-    uint32_t *element)
+int ia_css_queue_peek(ia_css_queue_t *qhandle, u32 offset, uint32_t *element)
 {
 	u32 num_elems = 0;
 	int error = 0;
@@ -354,9 +336,7 @@ int ia_css_queue_peek(
 	return -EINVAL;
 }
 
-int ia_css_queue_is_empty(
-    ia_css_queue_t *qhandle,
-    bool *is_empty)
+int ia_css_queue_is_empty(ia_css_queue_t *qhandle, bool *is_empty)
 {
 	int error = 0;
 
@@ -388,9 +368,7 @@ int ia_css_queue_is_empty(
 	return -EINVAL;
 }
 
-int ia_css_queue_get_size(
-    ia_css_queue_t *qhandle,
-    uint32_t *size)
+int ia_css_queue_get_size(ia_css_queue_t *qhandle, uint32_t *size)
 {
 	int error = 0;
 
Signature · 1 line
2.20.1
#14 lore raw

PATCH 12/12 media: atomisp: Fix LOGICAL_CONTINUATIONS

In reply to Philipp Gerlesberger

Logical continuations should be on the previous line

---
 drivers/staging/media/atomisp/pci/runtime/queue/src/queue.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/staging/media/atomisp/pci/runtime/queue/src/queue.c +2 -2
index 2f1c2df59f71..7d44070c7114 100644
@@ -24,8 +24,8 @@
  *****************************************************************************/
 int ia_css_queue_local_init(ia_css_queue_t *qhandle, ia_css_queue_local_t *desc)
 {
-	if (NULL == qhandle || NULL == desc
-	    || NULL == desc->cb_elems || NULL == desc->cb_desc) {
+	if (NULL == qhandle || NULL == desc ||
+	    NULL == desc->cb_elems || NULL == desc->cb_desc) {
 		/* Invalid parameters, return error*/
 		return -EINVAL;
 	}
Signature · 1 line
2.20.1