pbio/drv/counter: Rename virtual to virtual_cpython.

laurensvalk · laurensvalk · commit 761ba6acac8d · 2023-01-06T13:13:30.000+01:00
This allows us to add other virtual implementations.
diff --git a/bricks/_common/sources.mk b/bricks/_common/sources.mk
@@ -145,7 +145,7 @@ PBIO_SRC_C = $(addprefix lib/pbio/,\
 	drv/counter/counter_lpf2.c \
 	drv/counter/counter_nxt.c \
 	drv/counter/counter_stm32f0_gpio_quad_enc.c \
-	drv/counter/counter_virtual.c \
+	drv/counter/counter_virtual_cpython.c \
 	drv/gpio/gpio_stm32f0.c \
 	drv/gpio/gpio_stm32f4.c \
 	drv/gpio/gpio_stm32l4.c \
diff --git a/lib/pbio/cpython/pbio_virtual/drv/counter.py b/lib/pbio/cpython/pbio_virtual/drv/counter.py
@@ -5,23 +5,23 @@
 class VirtualCounter:
     rotations: int = 0
     """
-    Provides the rotations returned by ``pbdrv_counter_virtual_get_angle()``.
+    Provides the rotations returned by ``pbdrv_counter_virtual_cpython_get_angle()``.
 
     CPython code should write to this attribute to simulate the current value
     and the PBIO driver will read this attribute.
     """
 
     millidegrees: int = 0
     """
-    Provides the millidegrees returned by ``pbdrv_counter_virtual_get_angle()``.
+    Provides the millidegrees returned by ``pbdrv_counter_virtual_cpython_get_angle()``.
 
     CPython code should write to this attribute to simulate the current value
     and the PBIO driver will read this attribute.
     """
 
     millidegrees_abs: int = 0
     """
-    Provides the absolute angle returned by ``pbdrv_counter_virtual_get_abs_angle()``.
+    Provides the absolute angle returned by ``pbdrv_counter_virtual_cpython_get_abs_angle()``.
 
     CPython code should write to this attribute to simulate the current value
     and the PBIO driver will read this attribute.
diff --git a/lib/pbio/cpython/pbio_virtual/platform/robot.py b/lib/pbio/cpython/pbio_virtual/platform/robot.py
@@ -96,21 +96,21 @@ def __init__(self, sim_motor, clock):
     @property
     def rotations(self):
         """
-        Provides rotations for ``pbdrv_counter_virtual_get_angle()``.
+        Provides rotations for ``pbdrv_counter_virtual_cpython_get_angle()``.
         """
         return self.get_counter_data()[0]
 
     @property
     def millidegrees(self):
         """
-        Provides rotations for ``pbdrv_counter_virtual_get_angle()``.
+        Provides rotations for ``pbdrv_counter_virtual_cpython_get_angle()``.
         """
         return self.get_counter_data()[1]
 
     @property
     def millidegrees_abs(self):
         """
-        Provides the value for ``pbdrv_counter_virtual_get_abs_angle()``.
+        Provides the value for ``pbdrv_counter_virtual_cpython_get_abs_angle()``.
         """
         return self.get_counter_data()[2]
 
diff --git a/lib/pbio/drv/counter/counter_core.c b/lib/pbio/drv/counter/counter_core.c
@@ -15,7 +15,7 @@
 #include "counter_nxt.h"
 #include "counter_stm32f0_gpio_quad_enc.h"
 #include "counter_test.h"
-#include "counter_virtual.h"
+#include "counter_virtual_cpython.h"
 #include "counter.h"
 
 static pbdrv_counter_dev_t pbdrv_counter_devs[PBDRV_CONFIG_COUNTER_NUM_DEV];
@@ -26,7 +26,7 @@ void pbdrv_counter_init(void) {
     pbdrv_counter_nxt_init(pbdrv_counter_devs);
     pbdrv_counter_stm32f0_gpio_quad_enc_init(pbdrv_counter_devs);
     pbdrv_counter_test_init(pbdrv_counter_devs);
-    pbdrv_counter_virtual_init(pbdrv_counter_devs);
+    pbdrv_counter_virtual_cpython_init(pbdrv_counter_devs);
 }
 
 pbio_error_t pbdrv_counter_get_dev(uint8_t id, pbdrv_counter_dev_t **dev) {
diff --git a/lib/pbio/drv/counter/counter_virtual.h b/lib/pbio/drv/counter/counter_virtual.h
diff --git a/lib/pbio/drv/counter/counter_virtual_cpython.c b/lib/pbio/drv/counter/counter_virtual_cpython.c
@@ -5,7 +5,7 @@
 
 #include <pbdrv/config.h>
 
-#if PBDRV_CONFIG_COUNTER_VIRTUAL
+#if PBDRV_CONFIG_COUNTER_VIRTUAL_CPYTHON
 
 #include <errno.h>
 #include <stdint.h>
@@ -29,9 +29,9 @@ typedef struct {
     uint8_t index;
 } private_data_t;
 
-static private_data_t private_data[PBDRV_CONFIG_COUNTER_VIRTUAL_NUM_DEV];
+static private_data_t private_data[PBDRV_CONFIG_COUNTER_VIRTUAL_CPYTHON_NUM_DEV];
 
-static pbio_error_t pbdrv_counter_virtual_get_angle(pbdrv_counter_dev_t *dev, int32_t *rotations, int32_t *millidegrees) {
+static pbio_error_t pbdrv_counter_virtual_cpython_get_angle(pbdrv_counter_dev_t *dev, int32_t *rotations, int32_t *millidegrees) {
     private_data_t *priv = dev->priv;
 
     pbio_error_t err = pbdrv_virtual_get_i32("counter", priv->index, "rotations", rotations);
@@ -42,18 +42,18 @@ static pbio_error_t pbdrv_counter_virtual_get_angle(pbdrv_counter_dev_t *dev, in
     return pbdrv_virtual_get_i32("counter", priv->index, "millidegrees", millidegrees);
 }
 
-static pbio_error_t pbdrv_counter_virtual_get_abs_angle(pbdrv_counter_dev_t *dev, int32_t *millidegrees) {
+static pbio_error_t pbdrv_counter_virtual_cpython_get_abs_angle(pbdrv_counter_dev_t *dev, int32_t *millidegrees) {
     private_data_t *priv = dev->priv;
 
     return pbdrv_virtual_get_i32("counter", priv->index, "millidegrees_abs", millidegrees);
 }
 
-static const pbdrv_counter_funcs_t pbdrv_counter_virtual_funcs = {
-    .get_angle = pbdrv_counter_virtual_get_angle,
-    .get_abs_angle = pbdrv_counter_virtual_get_abs_angle,
+static const pbdrv_counter_funcs_t pbdrv_counter_virtual_cpython_funcs = {
+    .get_angle = pbdrv_counter_virtual_cpython_get_angle,
+    .get_abs_angle = pbdrv_counter_virtual_cpython_get_abs_angle,
 };
 
-void pbdrv_counter_virtual_init(pbdrv_counter_dev_t *devs) {
+void pbdrv_counter_virtual_cpython_init(pbdrv_counter_dev_t *devs) {
     for (size_t i = 0; i < PBIO_ARRAY_SIZE(private_data); i++) {
         private_data_t *priv = &private_data[i];
 
@@ -62,13 +62,13 @@ void pbdrv_counter_virtual_init(pbdrv_counter_dev_t *devs) {
         // FIXME: assuming that these are the only counter devices
         // counter_id should be passed from platform data instead
         // i.e. enumerate CPython `platform.counter.keys()`.
-        _Static_assert(PBDRV_CONFIG_COUNTER_VIRTUAL_NUM_DEV == PBDRV_CONFIG_COUNTER_NUM_DEV,
-            "need to fix counter_virtual implementation to allow other counter devices");
+        _Static_assert(PBDRV_CONFIG_COUNTER_VIRTUAL_CPYTHON_NUM_DEV == PBDRV_CONFIG_COUNTER_NUM_DEV,
+            "need to fix counter_virtual_cpython implementation to allow other counter devices");
 
         priv->dev = &devs[i];
-        priv->dev->funcs = &pbdrv_counter_virtual_funcs;
+        priv->dev->funcs = &pbdrv_counter_virtual_cpython_funcs;
         priv->dev->priv = priv;
     }
 }
 
-#endif // PBDRV_CONFIG_COUNTER_VIRTUAL
+#endif // PBDRV_CONFIG_COUNTER_VIRTUAL_CPYTHON
diff --git a/lib/pbio/drv/counter/counter_virtual_cpython.h b/lib/pbio/drv/counter/counter_virtual_cpython.h
@@ -0,0 +1,25 @@
+// SPDX-License-Identifier: MIT
+// Copyright (c) 2022 The Pybricks Authors
+
+#ifndef _INTERNAL_PBDRV_COUNTER_VIRTUAL_CPYTHON_H_
+#define _INTERNAL_PBDRV_COUNTER_VIRTUAL_CPYTHON_H_
+
+#include <pbdrv/config.h>
+
+#if PBDRV_CONFIG_COUNTER_VIRTUAL_CPYTHON
+
+#if !PBDRV_CONFIG_COUNTER_VIRTUAL_CPYTHON_NUM_DEV
+#error Platform must define PBDRV_CONFIG_COUNTER_VIRTUAL_CPYTHON_NUM_DEV
+#endif
+
+#include <pbdrv/counter.h>
+
+void pbdrv_counter_virtual_cpython_init(pbdrv_counter_dev_t *devs);
+
+#else // PBDRV_CONFIG_COUNTER_VIRTUAL_CPYTHON
+
+#define pbdrv_counter_virtual_cpython_init(devs)
+
+#endif // PBDRV_CONFIG_COUNTER_VIRTUAL_CPYTHON
+
+#endif // _INTERNAL_PBDRV_COUNTER_VIRTUAL_CPYTHON_H_
diff --git a/lib/pbio/platform/virtual_hub/pbdrvconfig.h b/lib/pbio/platform/virtual_hub/pbdrvconfig.h
@@ -12,8 +12,8 @@
 
 #define PBDRV_CONFIG_COUNTER                                (1)
 #define PBDRV_CONFIG_COUNTER_NUM_DEV                        (6)
-#define PBDRV_CONFIG_COUNTER_VIRTUAL                        (1)
-#define PBDRV_CONFIG_COUNTER_VIRTUAL_NUM_DEV                (6)
+#define PBDRV_CONFIG_COUNTER_VIRTUAL_CPYTHON                (1)
+#define PBDRV_CONFIG_COUNTER_VIRTUAL_CPYTHON_NUM_DEV        (6)
 
 #define PBDRV_CONFIG_IOPORT                                 (1)
 #define PBDRV_CONFIG_IOPORT_VIRTUAL                         (1)
