[rtl872x] Generalize API to fetch MAC address

Author: XuGuohui

hal/inc/deviceid_hal.h

@@ -96,13 +96,10 @@ int hal_get_device_hw_version(uint32_t* revision, void* reserved);
  */
 int hal_get_device_hw_model(uint32_t* model, uint32_t* variant, void* reserved);
 
-/**
- * Get the device's BLE MAC address.
- */
-int hal_get_ble_mac_address(uint8_t* dest, size_t destLen, void* reserved);
-
 #include "deviceid_hal_compat.h"
 
+#include "deviceid_hal_impl.h"
+
 #ifdef	__cplusplus
 }
 #endif

hal/src/nRF52840/deviceid_hal_impl.h

@@ -0,0 +1,20 @@
+/*
+ * Copyright (c) 2022 Particle Industries, Inc.  All rights reserved.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation, either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+// placeholder

hal/src/rtl872x/ble_hal.cpp

@@ -160,8 +160,14 @@ bool addressEqual(const hal_ble_addr_t& srcAddr, const hal_ble_addr_t& destAddr)
 
 hal_ble_addr_t chipDefaultPublicAddress() {
     hal_ble_addr_t localAddr = {};
-    hal_get_ble_mac_address(localAddr.addr, BLE_SIG_ADDR_LEN, nullptr);
-    localAddr.addr_type = BLE_SIG_ADDR_TYPE_PUBLIC;
+    uint8_t mac[BLE_SIG_ADDR_LEN] = {};
+    if (hal_get_mac_address(HAL_DEVICE_MAC_BLE, mac, BLE_SIG_ADDR_LEN, nullptr) == BLE_SIG_ADDR_LEN) {
+        // As per BLE spec, we store BLE data in little-endian
+        for (uint8_t i = 0, j = BLE_SIG_ADDR_LEN - 1; i < BLE_SIG_ADDR_LEN; i++, j--) {
+            localAddr.addr[i] = mac[j];
+        }
+        localAddr.addr_type = BLE_SIG_ADDR_TYPE_PUBLIC;
+    }
     return localAddr;
 }
 

hal/src/rtl872x/deviceid_hal.cpp

@@ -34,7 +34,6 @@ extern "C" {
 #include "rtl8721d_efuse.h"
 }
 
-
 namespace {
 
 using namespace particle;
@@ -50,20 +49,12 @@ using namespace particle;
 #define HARDWARE_DATA_OFFSET    0x178
 #define HARDWARE_MODEL_OFFSET   0x17B
 
-#define WIFI_MAC_SIZE                   6
-#define BLE_MAC_SIZE                    6
 #define SERIAL_NUMBER_FRONT_PART_SIZE   9
 #define HARDWARE_DATA_SIZE              4
 #define HARDWARE_MODEL_SIZE             4
 #define WIFI_OUID_SIZE                  3
 #define DEVICE_ID_PREFIX_SIZE           6
 
-// Offsets from base WiFi MAC address for reserved interfaces
-#define WIFI_STA_MAC_DELTA 0
-#define WIFI_AP_MAC_DELTA 1
-#define BLE_MAC_DELTA 2
-#define ETH_MAC_DELTA 3
-
 const uint8_t DEVICE_ID_PREFIX[] = {0x0a, 0x10, 0xac, 0xed, 0x20, 0x21};
 
 int readLogicalEfuse(uint32_t offset, uint8_t* buf, size_t size) {
@@ -107,20 +98,20 @@ int HAL_Get_Device_Identifier(const char** name, char* buf, size_t buflen, unsig
     return SYSTEM_ERROR_NOT_SUPPORTED;
 }
 
-int hal_get_ble_mac_address(uint8_t* dest, size_t destLen, void* reserved) {
-    CHECK_TRUE(dest && destLen >= BLE_MAC_SIZE, SYSTEM_ERROR_INVALID_ARGUMENT);
-    uint8_t mac[BLE_MAC_SIZE] = {};
-    destLen = BLE_MAC_SIZE;
-    CHECK(readLogicalEfuse(BLE_MAC_OFFSET, mac, BLE_MAC_SIZE));
-    // As per BLE spec, we store BLE data in little-endian
-    for (uint8_t i = 0, j = BLE_MAC_SIZE - 1; i < BLE_MAC_SIZE; i++, j--) {
-        dest[i] = mac[j];
+int hal_get_mac_address(uint8_t type, uint8_t* dest, size_t destLen, void* reserved) {
+    CHECK_TRUE(dest && destLen >= MAC_ADDR_SIZE, SYSTEM_ERROR_INVALID_ARGUMENT);
+    CHECK_TRUE(isSupportedMacType(type), SYSTEM_ERROR_INVALID_ARGUMENT);
+    uint8_t mac[MAC_ADDR_SIZE] = {};
+    if (type == HAL_DEVICE_MAC_BLE) {
+        CHECK(readLogicalEfuse(BLE_MAC_OFFSET, mac, MAC_ADDR_SIZE));
+    } else {
+        CHECK(readLogicalEfuse(WIFI_MAC_OFFSET, mac, MAC_ADDR_SIZE));
+        // Derive the final MAC address
+        mac[5] += type;
     }
-    return BLE_MAC_SIZE;
+    return MAC_ADDR_SIZE;
 }
 
-
-
 int hal_get_device_serial_number(char* str, size_t size, void* reserved) {
     char fullSerialNumber[HAL_DEVICE_SERIAL_NUMBER_SIZE] = {};
 
@@ -133,7 +124,7 @@ int hal_get_device_serial_number(char* str, size_t size, void* reserved) {
     CHECK(readLogicalEfuse(SERIAL_NUMBER_OFFSET, (uint8_t*)fullSerialNumber, SERIAL_NUMBER_FRONT_PART_SIZE));
 
     // generate hex string from non-OUI MAC bytes
-    uint8_t wifiMacRandomBytes[WIFI_MAC_SIZE - WIFI_OUID_SIZE] = {};
+    uint8_t wifiMacRandomBytes[MAC_ADDR_SIZE - WIFI_OUID_SIZE] = {};
     CHECK(readLogicalEfuse(WIFI_MAC_OFFSET + WIFI_OUID_SIZE, wifiMacRandomBytes, sizeof(wifiMacRandomBytes)));
     bytes2hexbuf(wifiMacRandomBytes, sizeof(wifiMacRandomBytes), &fullSerialNumber[SERIAL_NUMBER_FRONT_PART_SIZE]);
 

hal/src/rtl872x/deviceid_hal_impl.h

@@ -0,0 +1,43 @@
+/*
+ * Copyright (c) 2022 Particle Industries, Inc.  All rights reserved.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation, either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+#define MAC_ADDR_SIZE                   6
+
+#define HAL_DEVICE_MAC_WIFI_STA         0
+#define HAL_DEVICE_MAC_BLE              1
+#define HAL_DEVICE_MAC_WIFI_AP          2
+#define HAL_DEVICE_MAC_ETHERNET         3
+
+#define isSupportedMacType(type)        ((type) == HAL_DEVICE_MAC_WIFI_STA || \
+                                         (type) == HAL_DEVICE_MAC_BLE || \
+                                         (type) == HAL_DEVICE_MAC_WIFI_AP || \
+                                         (type) == HAL_DEVICE_MAC_ETHERNET)
+
+#ifdef	__cplusplus
+extern "C" {
+#endif
+
+/**
+ * Get the device's BLE MAC address.
+ */
+int hal_get_mac_address(uint8_t type, uint8_t* dest, size_t destLen, void* reserved);
+
+#ifdef	__cplusplus
+}
+#endif

hal/src/trackerm/network/network.cpp

@@ -154,10 +154,8 @@ int if_init_platform(void*) {
     reserve_netif_index();
 
     /* en2 - Ethernet FeatherWing (optional) */
-    uint8_t deviceId[HAL_DEVICE_ID_SIZE] = {};
-    hal_get_device_id(deviceId, sizeof(deviceId));
-    uint8_t* mac = deviceId + HAL_DEVICE_ID_SIZE - 6;
-    mac[5] += 3;
+    uint8_t mac[MAC_ADDR_SIZE] = {};
+    CHECK(hal_get_mac_address(HAL_DEVICE_MAC_ETHERNET, mac, MAC_ADDR_SIZE, nullptr));
 
     if (HAL_Feature_Get(FEATURE_ETHERNET_DETECTION)) {
         en2 = new WizNetif(HAL_SPI_INTERFACE1, D5, D3, D4, mac);