Retrieve the Opta™ MAC Address

Copy
1/**
2  Opta device information retrieval 
3  Name: opta_info.ino
4  Purpose: Retrieve information of an Opta device such as its bootloader version, hardware functionalities, external memory size, and MAC address.
5
6  @author Arduino PRO Content team
7  @version 1.0 27/03/22
8*/
9
10// Include the necessary header files and define macros
11uint8_t* bootloader_data = (uint8_t*)(0x801F000);
12uint8_t* bootloader_identification = (uint8_t*)(0x80002F0);
13
14#if __has_include("opta_info.h")
15  #include "opta_info.h"
16  #define GET_OPTA_OTP_BOARD_INFO
17  OptaBoardInfo* info;
18  OptaBoardInfo* boardInfo();
19#endif
20
21void setup() {
22  Serial.begin(115200);
23  while (!Serial) {}
24  delay(2500);
25
26  Serial.println("Opta Device Information");
27
28  uint8_t currentBootloaderVersion = bootloader_data[1];
29  String currentBootloaderIdentifier = String(bootloader_identification, 15);
30
31  if (!currentBootloaderIdentifier.equals("MCUboot Arduino")) {
32    currentBootloaderIdentifier = "Arduino loader";
33  }
34
35  Serial.println("- Bootloader identifier: " + currentBootloaderIdentifier);
36  Serial.println("- Magic number (validation): " + String(bootloader_data[0], HEX));
37  Serial.println("- Bootloader version: " + String(bootloader_data[1]));
38
39#if defined(GET_OPTA_OTP_BOARD_INFO)
40  printOptaSecureInfo();
41#endif
42}
43
44#if defined(GET_OPTA_OTP_BOARD_INFO)
45
46/**
47  Checks if the magic number is 0xB5. If it is, prints the secure information of the device in the Serial Monitor.
48  
49  @params none
50  @return none
51*/
52void printOptaSecureInfo() {
53  info = boardInfo();
54  if (info->magic == 0xB5) {
55    Serial.println("- Secure information version: " + String(info->version));
56    Serial.println("- Ethernet functionality: " + String(info->_board_functionalities.ethernet == 1 ? "Yes" : "No"));
57    Serial.println("- Wi-Fi module functionality: " + String(info->_board_functionalities.wifi == 1 ? "Yes" : "No"));
58    Serial.println("- RS-485 functionality: " + String(info->_board_functionalities.rs485 == 1 ? "Yes" : "No"));
59    Serial.println("- QSPI memory size: " + String(info->external_flash_size) + " MB");
60    Serial.println("- Secure board revision: " + String(info->revision >> 8) + "." + String(info->revision & 0xFF));
61    Serial.println("- Secure VID: 0x" + String(info->vid, HEX));
62    Serial.println("- Secure PID: 0x" + String(info->pid, HEX));
63    Serial.println("- Ethernet MAC address: " + String(info->mac_address[0], HEX) + ":" + String(info->mac_address[1], HEX) + ":" + String(info->mac_address[2], HEX) + ":" + String(info->mac_address[3], HEX) + ":" + String(info->mac_address[4], HEX) + ":" + String(info->mac_address[5], HEX));
64    if (info->_board_functionalities.wifi == 1) {
65      Serial.println("- Wi-Fi MAC address: " + String(info->mac_address_2[0], HEX) + ":" + String(info->mac_address_2[1], HEX) + ":" + String(info->mac_address_2[2], HEX) + ":" + String(info->mac_address_2[3], HEX) + ":" + String(info->mac_address_2[4], HEX) + ":" + String(info->mac_address_2[5], HEX));
66    }
67  } else {
68    Serial.println("- No secure information available!");
69    printBootloaderInfo();
70  }
71}
72#endif
73
74/**
75  Prints clock source, USB speed, Ethernet functionality, Wi-Fi functionality, RAM memory size, QSPI memory size, video output functionality, and secure element functionality.
76  
77  @params none
78  @return none
79*/
80void printBootloaderInfo() {
81  Serial.println("- Clock source: " + getClockSource(bootloader_data[2]));
82  Serial.println("- USB Speed: " + getUSBSpeed(bootloader_data[3]));
83  Serial.println("- Ethernet functionality: " + String(bootloader_data[4] == 1 ? "Yes" : "No"));
84  Serial.println("- Wi-Fi functionality: " + String(bootloader_data[5] == 1 ? "Yes" : "No"));
85  Serial.println("- RAM size: " + getRAMSize(bootloader_data[6]));
86  Serial.println("- QSPI memory size: " + String(bootloader_data[7]) + " MB");
87  Serial.println("- Video output functionality: " + String(bootloader_data[8] == 1 ? "Yes" : "No"));
88  Serial.println("- Secure element functionality: " + String(bootloader_data[9] == 1 ? "Yes" : "No"));
89}
90
91/**
92  Convert a flag in the bootloader data to USB speed information.
93  
94  @param bootloader flag (uint8_t)
95  @return USB speed information as a String
96*/
97String getUSBSpeed(uint8_t flag) {
98  switch (flag) {
99    case 1:
100      return "USB 2.0/Hi-Speed (480 Mbps)";
101    case 2:
102      return "USB 1.1/Full-Speed (12 Mbps)";
103    default:
104      return "N/A";
105  }
106}
107
108/**
109  Convert a flag in the bootloader data to clock source information.
110  
111  @param bootloader flag (uint8_t)
112  @return clock source information as a String
113*/
114String getClockSource(uint8_t flag) {
115  switch (flag) {
116    case 0x8:
117      return "External oscillator";
118    case 0x4:
119      return "External crystal";
120    case 0x2:
121      return "Internal clock";
122    default:
123      return "N/A";
124  }
125}
126
127/**
128  Convert a flag in the bootloader data to RAM size information.
129  
130  @param bootloader flag (uint8_t)
131  @return RAM size information as a String
132*/
133String getRAMSize(uint8_t flag) {
134  if (flag == 0) {
135    return "N/A";
136  }
137  return (String(flag) + "MB");
138}
139
140void loop() {
141  delay(1000);
142}