share more of _bleio dict; fix one doc error

2 files changed, 37 insertions, 56 deletions

diff --git a/shared-bindings/_bleio/Adapter.c b/shared-bindings/_bleio/Adapter.c
index 4facd818a..682177093 100644
--- a/shared-bindings/_bleio/Adapter.c
+++ b/shared-bindings/_bleio/Adapter.c
@@ -73,7 +73,7 @@
 //|         communicate with the HCI co-processor in HCI mode.
 //|         The `Adapter` object is enabled during this call.
 //|
-//|         After instantiating the Adapter, assign it to _bleio.adapter
+//|         After instantiating an Adapter, call `_bleio.set_adapter()` to set `_bleio.adapter`
 //|
 //|         On boards with native BLE, you cannot create an instance of `_bleio.Adapter`;
 //|         this constructor will raise `NotImplementedError`.
diff --git a/shared-bindings/_bleio/__init__.c b/shared-bindings/_bleio/__init__.c
index dece5820f..3d9084dd5 100644
--- a/shared-bindings/_bleio/__init__.c
+++ b/shared-bindings/_bleio/__init__.c
@@ -123,7 +123,8 @@ STATIC mp_obj_dict_t bleio_module_globals;
 #endif
 
 //| def set_adapter(adapter: Optional[_bleio.Adapter]) -> None:
-//|     """Set the adapter to use for BLE. Not settable when the adapter is a singleton."""
+//|     """Set the adapter to use for BLE, such as when using an HCI adapter.
+//|     Raises `NotImplementedError` when the adapter is a singleton and cannot be set."""
 //|     ...
 //|
 mp_obj_t bleio_set_adapter(mp_obj_t adapter_obj) {
@@ -147,73 +148,53 @@ MP_DEFINE_CONST_FUN_OBJ_1(bleio_set_adapter_obj, bleio_set_adapter);
 
 #if CIRCUITPY_BLEIO_HCI
 // Make the module dictionary be in RAM, so that _bleio.adapter can be set.
-
+// Use a local macro to define how table entries should be converted.
+#define OBJ_FROM_PTR MP_OBJ_FROM_PTR
 STATIC mp_map_elem_t bleio_module_globals_table[] = {
+#else
+#define OBJ_FROM_PTR MP_ROM_PTR
+STATIC const mp_rom_map_elem_t bleio_module_globals_table[] = {
+#endif
     // Name must be the first entry so that the exception printing below is correct.
     { MP_ROM_QSTR(MP_QSTR___name__),             MP_ROM_QSTR(MP_QSTR__bleio) },
-    { MP_ROM_QSTR(MP_QSTR_Adapter),              MP_OBJ_FROM_PTR(&bleio_adapter_type) },
-    { MP_ROM_QSTR(MP_QSTR_Address),              MP_OBJ_FROM_PTR(&bleio_address_type) },
-    { MP_ROM_QSTR(MP_QSTR_Attribute),            MP_OBJ_FROM_PTR(&bleio_attribute_type) },
-    { MP_ROM_QSTR(MP_QSTR_Connection),           MP_OBJ_FROM_PTR(&bleio_connection_type) },
-    { MP_ROM_QSTR(MP_QSTR_Characteristic),       MP_OBJ_FROM_PTR(&bleio_characteristic_type) },
-    { MP_ROM_QSTR(MP_QSTR_CharacteristicBuffer), MP_OBJ_FROM_PTR(&bleio_characteristic_buffer_type) },
-    { MP_ROM_QSTR(MP_QSTR_Descriptor),           MP_OBJ_FROM_PTR(&bleio_descriptor_type) },
-    { MP_ROM_QSTR(MP_QSTR_PacketBuffer),         MP_OBJ_FROM_PTR(&bleio_packet_buffer_type) },
-    { MP_ROM_QSTR(MP_QSTR_ScanEntry),            MP_OBJ_FROM_PTR(&bleio_scanentry_type) },
-    { MP_ROM_QSTR(MP_QSTR_ScanResults),          MP_OBJ_FROM_PTR(&bleio_scanresults_type) },
-    { MP_ROM_QSTR(MP_QSTR_Service),              MP_OBJ_FROM_PTR(&bleio_service_type) },
-    { MP_ROM_QSTR(MP_QSTR_UUID),                 MP_OBJ_FROM_PTR(&bleio_uuid_type) },
-
-    // Attributes
-    { MP_ROM_QSTR(MP_QSTR_adapter),              mp_const_none },
+    { MP_ROM_QSTR(MP_QSTR_Adapter),              OBJ_FROM_PTR(&bleio_adapter_type) },
+    { MP_ROM_QSTR(MP_QSTR_Address),              OBJ_FROM_PTR(&bleio_address_type) },
+    { MP_ROM_QSTR(MP_QSTR_Attribute),            OBJ_FROM_PTR(&bleio_attribute_type) },
+    { MP_ROM_QSTR(MP_QSTR_Connection),           OBJ_FROM_PTR(&bleio_connection_type) },
+    { MP_ROM_QSTR(MP_QSTR_Characteristic),       OBJ_FROM_PTR(&bleio_characteristic_type) },
+    { MP_ROM_QSTR(MP_QSTR_CharacteristicBuffer), OBJ_FROM_PTR(&bleio_characteristic_buffer_type) },
+    { MP_ROM_QSTR(MP_QSTR_Descriptor),           OBJ_FROM_PTR(&bleio_descriptor_type) },
+    { MP_ROM_QSTR(MP_QSTR_PacketBuffer),         OBJ_FROM_PTR(&bleio_packet_buffer_type) },
+    { MP_ROM_QSTR(MP_QSTR_ScanEntry),            OBJ_FROM_PTR(&bleio_scanentry_type) },
+    { MP_ROM_QSTR(MP_QSTR_ScanResults),          OBJ_FROM_PTR(&bleio_scanresults_type) },
+    { MP_ROM_QSTR(MP_QSTR_Service),              OBJ_FROM_PTR(&bleio_service_type) },
+    { MP_ROM_QSTR(MP_QSTR_UUID),                 OBJ_FROM_PTR(&bleio_uuid_type) },
 
-    // Functions
+#if CIRCUITPY_BLEIO_HCI
+    // For HCI, _bleio.adapter is settable, and starts as None.
+    { MP_ROM_QSTR(MP_QSTR_adapter),              mp_const_none },
     { MP_ROM_QSTR(MP_QSTR_set_adapter),          (mp_obj_t) &bleio_set_adapter_obj },
-
-    // Errors
-    { MP_ROM_QSTR(MP_QSTR_BluetoothError),       MP_OBJ_FROM_PTR(&mp_type_bleio_BluetoothError) },
-    { MP_ROM_QSTR(MP_QSTR_ConnectionError),      MP_OBJ_FROM_PTR(&mp_type_bleio_ConnectionError) },
-    { MP_ROM_QSTR(MP_QSTR_RoleError),            MP_OBJ_FROM_PTR(&mp_type_bleio_RoleError) },
-    { MP_ROM_QSTR(MP_QSTR_SecurityError),        MP_OBJ_FROM_PTR(&mp_type_bleio_SecurityError) },
-
-    // Initialization
-    { MP_ROM_QSTR(MP_QSTR___init__),             MP_OBJ_FROM_PTR(&bleio___init___obj) },
-};
-
-STATIC MP_DEFINE_MUTABLE_DICT(bleio_module_globals, bleio_module_globals_table);
-
 #else
-// When _bleio.adapter is a singleton, and can't be set.
-
-STATIC const mp_rom_map_elem_t bleio_module_globals_table[] = {
-    // Name must be the first entry so that the exception printing below is correct.
-    { MP_ROM_QSTR(MP_QSTR___name__),             MP_ROM_QSTR(MP_QSTR__bleio) },
-    { MP_ROM_QSTR(MP_QSTR_Adapter),              MP_ROM_PTR(&bleio_adapter_type) },
-    { MP_ROM_QSTR(MP_QSTR_Address),              MP_ROM_PTR(&bleio_address_type) },
-    { MP_ROM_QSTR(MP_QSTR_Attribute),            MP_ROM_PTR(&bleio_attribute_type) },
-    { MP_ROM_QSTR(MP_QSTR_Connection),           MP_ROM_PTR(&bleio_connection_type) },
-    { MP_ROM_QSTR(MP_QSTR_Characteristic),       MP_ROM_PTR(&bleio_characteristic_type) },
-    { MP_ROM_QSTR(MP_QSTR_CharacteristicBuffer), MP_ROM_PTR(&bleio_characteristic_buffer_type) },
-    { MP_ROM_QSTR(MP_QSTR_Descriptor),           MP_ROM_PTR(&bleio_descriptor_type) },
-    { MP_ROM_QSTR(MP_QSTR_PacketBuffer),         MP_ROM_PTR(&bleio_packet_buffer_type) },
-    { MP_ROM_QSTR(MP_QSTR_ScanEntry),            MP_ROM_PTR(&bleio_scanentry_type) },
-    { MP_ROM_QSTR(MP_QSTR_ScanResults),          MP_ROM_PTR(&bleio_scanresults_type) },
-    { MP_ROM_QSTR(MP_QSTR_Service),              MP_ROM_PTR(&bleio_service_type) },
-    { MP_ROM_QSTR(MP_QSTR_UUID),                 MP_ROM_PTR(&bleio_uuid_type) },
-
-    // Properties
+    // For non-HCI _bleio.adapter is a fixed singleton, and is not settable.
+    // _bleio.set_adapter will raise NotImplementedError.
     { MP_ROM_QSTR(MP_QSTR_adapter),              MP_ROM_PTR(&common_hal_bleio_adapter_obj) },
+    { MP_ROM_QSTR(MP_QSTR_set_adapter),          MP_ROM_PTR(&bleio_set_adapter_obj) },
+#endif
 
     // Errors
-    { MP_ROM_QSTR(MP_QSTR_BluetoothError),      MP_ROM_PTR(&mp_type_bleio_BluetoothError) },
-    { MP_ROM_QSTR(MP_QSTR_ConnectionError),     MP_ROM_PTR(&mp_type_bleio_ConnectionError) },
-    { MP_ROM_QSTR(MP_QSTR_RoleError),           MP_ROM_PTR(&mp_type_bleio_RoleError) },
-    { MP_ROM_QSTR(MP_QSTR_SecurityError),       MP_ROM_PTR(&mp_type_bleio_SecurityError) },
+    { MP_ROM_QSTR(MP_QSTR_BluetoothError),       OBJ_FROM_PTR(&mp_type_bleio_BluetoothError) },
+    { MP_ROM_QSTR(MP_QSTR_ConnectionError),      OBJ_FROM_PTR(&mp_type_bleio_ConnectionError) },
+    { MP_ROM_QSTR(MP_QSTR_RoleError),            OBJ_FROM_PTR(&mp_type_bleio_RoleError) },
+    { MP_ROM_QSTR(MP_QSTR_SecurityError),        OBJ_FROM_PTR(&mp_type_bleio_SecurityError) },
 
     // Initialization
-    { MP_ROM_QSTR(MP_QSTR___init__),            MP_ROM_PTR(&bleio___init___obj) },
+    { MP_ROM_QSTR(MP_QSTR___init__),             OBJ_FROM_PTR(&bleio___init___obj) },
 };
 
+#if CIRCUITPY_BLEIO_HCI
+// Module dict is mutable to allow setting _bleio.adapter.
+STATIC MP_DEFINE_MUTABLE_DICT(bleio_module_globals, bleio_module_globals_table);
+#else
 STATIC MP_DEFINE_CONST_DICT(bleio_module_globals, bleio_module_globals_table);
 #endif