usbd: Changes to match new low-level API.

This won't be exactly the final API, but allows examples to keep working.

Signed-off-by: Angus Gratton <[email protected]>

Author: projectgus

micropython/usbd/device.py

@@ -48,7 +48,7 @@ def get():
     # MicroPython _USBDevice object
     #
     # (note this isn't the low-level object, the low-level object is
-    # _get()._usbd.)
+    # get()._usbd.)
     global _dev
     if not _dev:
         _dev = _USBDevice()
@@ -64,12 +64,12 @@ def __init__(self):
         self._itfs = {}  # Mapping from interface number to interface object, set by init()
         self._eps = {}  # Mapping from endpoint address to interface object, set by _open_cb()
         self._ep_cbs = {}  # Mapping from endpoint address to Optional[xfer callback]
-        self._usbd = machine.USBD()  # low-level USBD object
+        self._usbd = machine.USBDevice()  # low-level API
 
     def init(  # noqa: PLR0913 TODO: find a way to pass fewer arguments without wasting RAM
         self,
         *itfs,
-        static_drivers=False,
+        builtin_drivers=False,
         active=True,
         manufacturer_str=None,
         product_str=None,
@@ -88,24 +88,29 @@ def init(  # noqa: PLR0913 TODO: find a way to pass fewer arguments without wast
         # device and configuration descriptor fields
 
         _usbd = self._usbd
-        static = _usbd.static
 
-        # Putting None for any strings that should fall back to the "static" value
+        _usbd.active(False)
+
+        builtin = _usbd.builtin_driver = (
+            _usbd.BUILTIN_DEFAULT if builtin_drivers else _usbd.BUILTIN_NONE
+        )
+
+        # Putting None for any strings that should fall back to the "built-in" value
         # Indexes in this list depends on _USB_STR_MANUF, _USB_STR_PRODUCT, _USB_STR_SERIAL
         strs = [None, manufacturer_str, product_str, serial_str]
 
         # Build the device descriptor
         FMT = "<BBHBBBBHHHBBBB"
         # read the static descriptor fields
-        f = struct.unpack(FMT, static.desc_dev)
+        f = struct.unpack(FMT, builtin.desc_dev)
 
         def maybe_set(value, idx):
-            # Override a numeric descriptor value or keep static value f[idx] if 'value' is None
+            # Override a numeric descriptor value or keep builtin value f[idx] if 'value' is None
             if value is not None:
                 return value
             return f[idx]
 
-        # Either copy each descriptor field directly from the static device descriptor, or 'maybe'
+        # Either copy each descriptor field directly from the builtin device descriptor, or 'maybe'
         # set it to the custom value from the object
         desc_dev = struct.pack(
             FMT,
@@ -128,16 +133,11 @@ def maybe_set(value, idx):
         # Iterate interfaces to build the configuration descriptor
 
         # Keep track of the interface and endpoint indexes
-        if static_drivers:
-            itf_num = static.itf_max
-            ep_num = max(static.ep_max, 1)  # Endpoint 0 always reserved for control
-            while len(strs) < static.str_max:
-                strs.append(None)  # Reserve other string indexed used by static drivers
-            initial_cfg = static.desc_cfg
-        else:
-            itf_num = 0
-            ep_num = 1
-            initial_cfg = b"\x00" * _STD_DESC_CONFIG_LEN  # Reserved space for config descriptor
+        itf_num = builtin.itf_max
+        ep_num = max(builtin.ep_max, 1)  # Endpoint 0 always reserved for control
+        while len(strs) < builtin.str_max:
+            strs.append(None)  # Reserve other string indexes used by builtin drivers
+        initial_cfg = builtin.desc_cfg or (b"\x00" * _STD_DESC_CONFIG_LEN)
 
         self._itfs = {}
 
@@ -191,18 +191,16 @@ def maybe_set(value, idx):
             max_power_ma,
         )
 
-        # Initialise the USB device
-        _usbd.init(
+        _usbd.config(
             desc_dev,
             desc.b,
             strs,
-            static_drivers,
             self._open_itf_cb,
             self._reset_cb,
             self._control_xfer_cb,
             self._xfer_cb,
-            active,
         )
+        _usbd.active(active)
 
     def _open_itf_cb(self, desc):
         # Singleton callback from TinyUSB custom class driver, when USB host does
@@ -266,7 +264,7 @@ def _submit_xfer(self, ep_addr, data, done_cb=None):
         if self._ep_cbs[ep_addr]:
             raise RuntimeError("xfer_pending")
 
-        # USBD callback may be called immediately, before Python execution
+        # USBDevice callback may be called immediately, before Python execution
         # continues, so set it first.
         #
         # To allow xfer_pending checks to work, store True instead of None.

micropython/usbd/examples/cdc_repl_example.py

@@ -6,9 +6,9 @@
 cdc = CDC()
 cdc.init(timeout=0)  # zero timeout makes this non-blocking, suitable for os.dupterm()
 
-# pass static_drivers=True so that we get the static USB-CDC alongside,
+# pass builtin_drivers=True so that we get the static USB-CDC alongside,
 # if it's available.
-usbd.device.get().init(cdc, static_drivers=True)
+usbd.device.get().init(cdc, builtin_drivers=True)
 
 print("Waiting for USB host to configure the interface...")
 

micropython/usbd/examples/hid_mouse_example.py

@@ -12,9 +12,9 @@
 def mouse_example():
     m = MouseInterface()
 
-    # Note: static_drivers=True means that if there's a USB-CDC REPL
+    # Note: builtin_drivers=True means that if there's a USB-CDC REPL
     # available then it will appear as well as the HID device.
-    usbd.device.get().init(m, static_drivers=True)
+    usbd.device.get().init(m, builtin_drivers=True)
 
     # wait for host to enumerate as a HID device...
     while not m.is_open():