Re: [PATCH 3/2] hw/timer: Rename ptimer_state -> PTimer
On 17/02/2023 22.58, Philippe Mathieu-Daudé wrote:
Remove a pointless cast in ptimer_tick() and rename 'ptimer_state'
as 'PTimer' to follow the Structure naming convention.
See docs/devel/style.rst:
Variables are lower_case_with_underscores; easy to type and
read. Structured type names are in CamelCase; harder to type
but standing out. Enum type names and function type names
should also be in CamelCase. Scalar type names are
lower_case_with_underscores_ending_with_a_t, like the POSIX
uint64_t and family.
Mechanical change doing:
$ sed -i -e s/ptimer_state/PTimer/g \
$(git grep -l ptimer_state)
Suggested-by: Thomas Huth
Signed-off-by: Philippe Mathieu-Daudé
---
...
@@ -154,7 +154,7 @@ static void ptimer_reload(ptimer_state *s, int delta_adjust)
static void ptimer_tick(void *opaque)
{
-ptimer_state *s = (ptimer_state *)opaque;
+PTimer *s = opaque;
I like that you also removed the useless cast here.
bool trigger = true;
/*
@@ -198,7 +198,7 @@ static void ptimer_tick(void *opaque)
ptimer_transaction_commit(s);
}
-uint64_t ptimer_get_count(ptimer_state *s)
+uint64_t ptimer_get_count(PTimer *s)
{
uint64_t counter;
@@ -294,7 +294,7 @@ uint64_t ptimer_get_count(ptimer_state *s)
return counter;
}
-void ptimer_set_count(ptimer_state *s, uint64_t count)
+void ptimer_set_count(PTimer *s, uint64_t count)
{
assert(s->in_transaction);
s->delta = count;
@@ -303,7 +303,7 @@ void ptimer_set_count(ptimer_state *s, uint64_t count)
}
}
-void ptimer_run(ptimer_state *s, int oneshot)
+void ptimer_run(PTimer *s, int oneshot)
{
bool was_disabled = !s->enabled;
@@ -323,7 +323,7 @@ void ptimer_run(ptimer_state *s, int oneshot)
/* Pause a timer. Note that this may cause it to "lose" time, even if it
is immediately restarted. */
-void ptimer_stop(ptimer_state *s)
+void ptimer_stop(PTimer *s)
{
assert(s->in_transaction);
@@ -337,7 +337,7 @@ void ptimer_stop(ptimer_state *s)
}
/* Set counter increment interval in nanoseconds. */
-void ptimer_set_period(ptimer_state *s, int64_t period)
+void ptimer_set_period(PTimer *s, int64_t period)
{
assert(s->in_transaction);
s->delta = ptimer_get_count(s);
@@ -349,7 +349,7 @@ void ptimer_set_period(ptimer_state *s, int64_t period)
}
/* Set counter increment interval from a Clock */
-void ptimer_set_period_from_clock(ptimer_state *s, const Clock *clk,
+void ptimer_set_period_from_clock(PTimer *s, const Clock *clk,
unsigned int divisor)
{
/*
@@ -382,7 +382,7 @@ void ptimer_set_period_from_clock(ptimer_state *s, const
Clock *clk,
}
/* Set counter frequency in Hz. */
-void ptimer_set_freq(ptimer_state *s, uint32_t freq)
+void ptimer_set_freq(PTimer *s, uint32_t freq)
{
assert(s->in_transaction);
s->delta = ptimer_get_count(s);
@@ -395,7 +395,7 @@ void ptimer_set_freq(ptimer_state *s, uint32_t freq)
/* Set the initial countdown value. If reload is nonzero then also set
count = limit. */
-void ptimer_set_limit(ptimer_state *s, uint64_t limit, int reload)
+void ptimer_set_limit(PTimer *s, uint64_t limit, int reload)
{
assert(s->in_transaction);
s->limit = limit;
@@ -406,19 +406,19 @@ void ptimer_set_limit(ptimer_state *s, uint64_t limit,
int reload)
}
}
-uint64_t ptimer_get_limit(ptimer_state *s)
+uint64_t ptimer_get_limit(PTimer *s)
{
return s->limit;
}
-void ptimer_transaction_begin(ptimer_state *s)
+void ptimer_transaction_begin(PTimer *s)
{
assert(!s->in_transaction);
s->in_transaction = true;
s->need_reload = false;
}
-void ptimer_transaction_commit(ptimer_state *s)
+void ptimer_transaction_commit(PTimer *s)
{
assert(s->in_transaction);
/*
@@ -442,27 +442,27 @@ const VMStateDescription vmstate_ptimer = {
.version_id = 1,
.minimum_version_id = 1,
.fields = (VMStateField[]) {
-VMSTATE_UINT8(enabled, ptimer_state),
-VMSTATE_UINT64(limit, ptimer_state),
-VMSTATE_UINT64(delta, ptimer_state),
-VMSTATE_UINT32(period_frac, ptimer_state),
-VMSTATE_INT64(period, ptimer_state),
-VMSTATE_INT64(last_event, ptimer_state),
-VMSTATE_INT64(next_event, ptimer_state),
-VMSTATE_TIMER_PTR(timer, ptimer_state),
+VMSTATE_UINT8(enabled, PTimer),
+VMSTATE_UINT64(limit, PTimer),
+VMSTATE_UINT64(delta, PTimer),
+VMSTATE_UINT32(period_frac, PTimer),
+VMSTATE_INT64(period, PTimer),
+VMSTATE_INT64(last_event, PTimer),
+VMSTATE_INT64(next_event, PTimer),
+VMSTATE_TIMER_PTR(timer, PTimer),
VMSTATE_END_OF_LIST()
}
};
-ptimer_state *ptimer_init(ptimer_cb callback, void *callback_opaque,
+PTimer *ptimer_init(ptimer_cb callback, void *callback_opaque,
uint8_t policy_mask)
Just a
[PATCH 3/2] hw/timer: Rename ptimer_state -> PTimer
Remove a pointless cast in ptimer_tick() and rename 'ptimer_state'
as 'PTimer' to follow the Structure naming convention.
See docs/devel/style.rst:
Variables are lower_case_with_underscores; easy to type and
read. Structured type names are in CamelCase; harder to type
but standing out. Enum type names and function type names
should also be in CamelCase. Scalar type names are
lower_case_with_underscores_ending_with_a_t, like the POSIX
uint64_t and family.
Mechanical change doing:
$ sed -i -e s/ptimer_state/PTimer/g \
$(git grep -l ptimer_state)
Suggested-by: Thomas Huth
Signed-off-by: Philippe Mathieu-Daudé
---
hw/arm/musicpal.c| 2 +-
hw/core/ptimer.c | 56
hw/dma/xilinx_axidma.c | 2 +-
hw/m68k/mcf5206.c| 2 +-
hw/m68k/mcf5208.c| 2 +-
hw/net/fsl_etsec/etsec.h | 2 +-
hw/net/lan9118.c | 2 +-
hw/rtc/exynos4210_rtc.c | 4 +-
hw/timer/altera_timer.c | 2 +-
hw/timer/arm_mptimer.c | 4 +-
hw/timer/arm_timer.c | 2 +-
hw/timer/etraxfs_timer.c | 8 ++--
hw/timer/exynos4210_mct.c| 8 ++--
hw/timer/exynos4210_pwm.c| 2 +-
hw/timer/grlib_gptimer.c | 2 +-
hw/timer/sh_timer.c | 2 +-
hw/timer/slavio_timer.c | 2 +-
hw/timer/xilinx_timer.c | 2 +-
include/hw/display/xlnx_dp.h | 2 +-
include/hw/dma/xlnx_csu_dma.h| 2 +-
include/hw/net/xlnx-zynqmp-can.h | 2 +-
include/hw/ptimer.h | 34 +++---
include/hw/timer/allwinner-a10-pit.h | 2 +-
include/hw/timer/arm_mptimer.h | 2 +-
include/hw/timer/armv7m_systick.h| 2 +-
include/hw/timer/cmsdk-apb-dualtimer.h | 2 +-
include/hw/timer/cmsdk-apb-timer.h | 2 +-
include/hw/timer/digic-timer.h | 2 +-
include/hw/timer/imx_epit.h | 4 +-
include/hw/timer/imx_gpt.h | 2 +-
include/hw/timer/mss-timer.h | 2 +-
include/hw/watchdog/cmsdk-apb-watchdog.h | 2 +-
include/hw/watchdog/wdt_imx2.h | 4 +-
include/qemu/typedefs.h | 2 +-
tests/unit/ptimer-test.c | 22 +-
35 files changed, 98 insertions(+), 98 deletions(-)
diff --git a/hw/arm/musicpal.c b/hw/arm/musicpal.c
index 89b66606c3..63e0bbda95 100644
--- a/hw/arm/musicpal.c
+++ b/hw/arm/musicpal.c
@@ -435,7 +435,7 @@ static const TypeInfo mv88w8618_pic_info = {
#define MP_BOARD_RESET_MAGIC0x1
typedef struct mv88w8618_timer_state {
-ptimer_state *ptimer;
+PTimer *ptimer;
uint32_t limit;
int freq;
qemu_irq irq;
diff --git a/hw/core/ptimer.c b/hw/core/ptimer.c
index eb5ba1aff7..3ff49a0a04 100644
--- a/hw/core/ptimer.c
+++ b/hw/core/ptimer.c
@@ -19,7 +19,7 @@
#define DELTA_ADJUST 1
#define DELTA_NO_ADJUST -1
-struct ptimer_state
+struct PTimer
{
uint8_t enabled; /* 0 = disabled, 1 = periodic, 2 = oneshot. */
uint64_t limit;
@@ -43,12 +43,12 @@ struct ptimer_state
};
/* Use a bottom-half routine to avoid reentrancy issues. */
-static void ptimer_trigger(ptimer_state *s)
+static void ptimer_trigger(PTimer *s)
{
s->callback(s->callback_opaque);
}
-static void ptimer_reload(ptimer_state *s, int delta_adjust)
+static void ptimer_reload(PTimer *s, int delta_adjust)
{
uint32_t period_frac;
uint64_t period;
@@ -73,7 +73,7 @@ static void ptimer_reload(ptimer_state *s, int delta_adjust)
/*
* Note that ptimer_trigger() might call the device callback function,
* which can then modify timer state, so we must not cache any fields
- * from ptimer_state until after we have called it.
+ * from PTimer state until after we have called it.
*/
delta = s->delta;
period = s->period;
@@ -154,7 +154,7 @@ static void ptimer_reload(ptimer_state *s, int delta_adjust)
static void ptimer_tick(void *opaque)
{
-ptimer_state *s = (ptimer_state *)opaque;
+PTimer *s = opaque;
bool trigger = true;
/*
@@ -198,7 +198,7 @@ static void ptimer_tick(void *opaque)
ptimer_transaction_commit(s);
}
-uint64_t ptimer_get_count(ptimer_state *s)
+uint64_t ptimer_get_count(PTimer *s)
{
uint64_t counter;
@@ -294,7 +294,7 @@ uint64_t ptimer_get_count(ptimer_state *s)
return counter;
}
-void ptimer_set_count(ptimer_state *s, uint64_t count)
+void ptimer_set_count(PTimer *s, uint64_t count)
{
assert(s->in_transaction);
s->delta = count;
@@ -303,7 +303,7 @@ void ptimer_set_count(ptimer_state *s, uint64_t count)
}
}
-void ptimer_run(ptimer_state *s, int oneshot)
+void ptimer_run(PTimer *s, int oneshot)
{
bool was_disabled = !s->enabled;
@@ -323,7 +323,7 @@ void ptimer_run(ptimer_state
