From 44bc1711aa2eb093329bdbd4ee8c137bd2f7a9f4 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Thu, 18 Jan 2018 13:39:11 -0600 Subject: Added Unique ID Functions/Updated Support Matrix (#527) shared_bindings/index.rst: updated Support Matrix format as discussed in PR #503 & Issue #448. shared-bindings/microcontroller/Processor.c & .h: added UID lookup functionality for use with all ports. Fixes #462. --- .../common-hal/microcontroller/Processor.c | 17 +++++++ .../common-hal/microcontroller/Processor.h | 2 + .../esp8266/common-hal/microcontroller/Processor.c | 7 +++ .../esp8266/common-hal/microcontroller/Processor.h | 2 + ports/nrf/common-hal/microcontroller/Processor.c | 10 ++++ ports/nrf/common-hal/microcontroller/Processor.h | 2 + shared-bindings/index.rst | 59 ++++++++++++---------- shared-bindings/microcontroller/Processor.c | 23 ++++++++- shared-bindings/microcontroller/Processor.h | 1 + 9 files changed, 95 insertions(+), 28 deletions(-) diff --git a/ports/atmel-samd/common-hal/microcontroller/Processor.c b/ports/atmel-samd/common-hal/microcontroller/Processor.c index 21bc9aed0..1c57808f7 100644 --- a/ports/atmel-samd/common-hal/microcontroller/Processor.c +++ b/ports/atmel-samd/common-hal/microcontroller/Processor.c @@ -230,3 +230,20 @@ uint32_t common_hal_mcu_processor_get_frequency(void) { // TODO(tannewt): Determine this dynamically. return CONF_CPU_FREQUENCY; } + +void common_hal_mcu_processor_get_uid(uint8_t raw_id[]) { + #ifdef SAMD21 + uint32_t* id_addresses[4] = {(uint32_t *) 0x0080A00C, (uint32_t *) 0x0080A040, + (uint32_t *) 0x0080A044, (uint32_t *) 0x0080A048}; + #endif + #ifdef SAMD51 + uint32_t* id_addresses[4] = {(uint32_t *) 0x008061FC, (uint32_t *) 0x00806010, + (uint32_t *) 0x00806014, (uint32_t *) 0x00806018}; + #endif + + for (int i=0; i<4; i++) { + for (int k=0; k<4; k++) { + raw_id[4 * i + k] = (*(id_addresses[i]) >> k * 8) & 0xf; + } + } +} diff --git a/ports/atmel-samd/common-hal/microcontroller/Processor.h b/ports/atmel-samd/common-hal/microcontroller/Processor.h index 81f92bb0f..1e1d201eb 100644 --- a/ports/atmel-samd/common-hal/microcontroller/Processor.h +++ b/ports/atmel-samd/common-hal/microcontroller/Processor.h @@ -27,6 +27,8 @@ #ifndef MICROPY_INCLUDED_ATMEL_SAMD_COMMON_HAL_MICROCONTROLLER_PROCESSOR_H #define MICROPY_INCLUDED_ATMEL_SAMD_COMMON_HAL_MICROCONTROLLER_PROCESSOR_H +#define COMMON_HAL_MCU_PROCESSOR_UID_LENGTH 16 + #include "py/obj.h" typedef struct { diff --git a/ports/esp8266/common-hal/microcontroller/Processor.c b/ports/esp8266/common-hal/microcontroller/Processor.c index fb0a3d50a..097cc34b5 100644 --- a/ports/esp8266/common-hal/microcontroller/Processor.c +++ b/ports/esp8266/common-hal/microcontroller/Processor.c @@ -38,3 +38,10 @@ float common_hal_mcu_processor_get_temperature(void) { uint32_t common_hal_mcu_processor_get_frequency(void) { return mp_hal_get_cpu_freq(); } + +void common_hal_mcu_processor_get_uid(uint8_t raw_id[]) { + uint32_t id = system_get_chip_id(); + for (int i=0; i<4; i++){ + raw_id[i] = id >> (i * 8); + } +} diff --git a/ports/esp8266/common-hal/microcontroller/Processor.h b/ports/esp8266/common-hal/microcontroller/Processor.h index 8fc59c2cb..7d7861fd5 100644 --- a/ports/esp8266/common-hal/microcontroller/Processor.h +++ b/ports/esp8266/common-hal/microcontroller/Processor.h @@ -27,6 +27,8 @@ #ifndef MICROPY_INCLUDED_ESP8266_COMMON_HAL_MICROCONTROLLER_PROCESSOR_H #define MICROPY_INCLUDED_ESP8266_COMMON_HAL_MICROCONTROLLER_PROCESSOR_H +#define COMMON_HAL_MCU_PROCESSOR_UID_LENGTH 4 + #include "py/obj.h" typedef struct { diff --git a/ports/nrf/common-hal/microcontroller/Processor.c b/ports/nrf/common-hal/microcontroller/Processor.c index 4e74a4909..ba5aa0932 100644 --- a/ports/nrf/common-hal/microcontroller/Processor.c +++ b/ports/nrf/common-hal/microcontroller/Processor.c @@ -35,3 +35,13 @@ uint32_t common_hal_mcu_processor_get_frequency(void) { return 64000000ul; } +void common_hal_mcu_processor_get_uid(uint8_t raw_id[]) { + + uint32_t* id_addresses[2] = {(uint32_t *) 0x060, (uint32_t *) 0x064}; + + for (int i=0; i<2; i++) { + for (int k=0; k<4; k++) { + raw_id[4 * i + k] = (*(id_addresses[i]) >> k * 8) & 0xf; + } + } +} diff --git a/ports/nrf/common-hal/microcontroller/Processor.h b/ports/nrf/common-hal/microcontroller/Processor.h index 00d95ad4f..4049c165f 100644 --- a/ports/nrf/common-hal/microcontroller/Processor.h +++ b/ports/nrf/common-hal/microcontroller/Processor.h @@ -27,6 +27,8 @@ #ifndef MICROPY_INCLUDED_NRF_COMMON_HAL_MICROCONTROLLER_PROCESSOR_H #define MICROPY_INCLUDED_NRF_COMMON_HAL_MICROCONTROLLER_PROCESSOR_H +#define COMMON_HAL_MCU_PROCESSOR_UID_LENGTH 8 + #include "py/obj.h" typedef struct { diff --git a/shared-bindings/index.rst b/shared-bindings/index.rst index 7541f8ccf..d1261dcd2 100644 --- a/shared-bindings/index.rst +++ b/shared-bindings/index.rst @@ -11,34 +11,39 @@ limited. For example, a microcontroller without analog features will not have Support Matrix --------------- +NOTE 1: **All Supported** means the following ports are supported: SAMD21, SAMD21 Express, +SAMD51, SAMD51 Express, and ESP8266. -================= ======= ============== ======= -Module / Port SAMD21 SAMD21 Express ESP8266 -================= ======= ============== ======= -`analogio` **Yes** **Yes** **Yes** -`audiobusio` **Yes** **Yes** No -`audioio` No **Yes** No -`bitbangio` No **Yes** **Yes** -`board` **Yes** **Yes** **Yes** -`busio` **Yes** **Yes** **Yes** -`digitalio` **Yes** **Yes** **Yes** -`gamepad` No **Yes** No -`math` **Yes** **Yes** **Yes** -`microcontroller` **Yes** **Yes** **Yes** -`multiterminal` No No **Yes** -`neopixel_write` **Yes** **Yes** **Yes** -`nvm` No **Yes** No -`os` **Yes** **Yes** **Yes** -`pulseio` **Yes** **Yes** No -`random` **Yes** **Yes** **Yes** -`storage` **Yes** **Yes** **Yes** -`struct` **Yes** **Yes** **Yes** -`supervisor` **Yes** **Yes** No -`time` **Yes** **Yes** **Yes** -`touchio` **Yes** **Yes** No -`uheap` Debug Debug Debug -`usb_hid` **Yes** **Yes** No -================= ======= ============== ======= +NOTE 2: **SAMD** and/or **SAMD Express** without additional numbers, means both SAMD21 & SAMD51 versions +are supported. + +================= =============== +Module Supported Ports +================= =============== +`analogio` **All Supported** +`audiobusio` **SAMD/SAMD Express** +`audioio` **SAMD Express** +`bitbangio` **SAMD Express, ESP8266** +`board` **All Supported** +`busio` **All Supported** +`digitalio` **All Supported** +`gamepad` **SAMD Express** +`math` **All Supported** +`microcontroller` **All Supported** +`multiterminal` **ESP8266** +`neopixel_write` **All Supported** +`nvm` **SAMD Express** +`os` **All Supported** +`pulseio` **SAMD/SAMD Express** +`random` **All Supported** +`storage` **All Supported** +`struct` **All Supported** +`supervisor` **SAMD/SAMD Express** +`time` **All Supported** +`touchio` **SAMD/SAMD Express** +`uheap` **Debug (All)** +`usb_hid` **SAMD/SAMD Express** +================= =============== Modules --------- diff --git a/shared-bindings/microcontroller/Processor.c b/shared-bindings/microcontroller/Processor.c index 0e843bd31..7cc0d6016 100644 --- a/shared-bindings/microcontroller/Processor.c +++ b/shared-bindings/microcontroller/Processor.c @@ -32,7 +32,6 @@ #include "py/objproperty.h" -#include "py/objproperty.h" #include "py/runtime.h" //| .. currentmodule:: microcontroller @@ -93,9 +92,31 @@ const mp_obj_property_t mcu_processor_temperature_obj = { }, }; +//| .. attribute:: uid +//| +//| Return the unique id (aka serial number) of the chip. +//| Returns a bytearray object. +//| +STATIC mp_obj_t mcu_processor_get_uid(mp_obj_t self) { + uint8_t raw_id[COMMON_HAL_MCU_PROCESSOR_UID_LENGTH]; + common_hal_mcu_processor_get_uid(raw_id); + return mp_obj_new_bytearray(sizeof(raw_id), raw_id); +} + +MP_DEFINE_CONST_FUN_OBJ_1(mcu_processor_get_uid_obj, mcu_processor_get_uid); + +const mp_obj_property_t mcu_processor_uid_obj = { + .base.type = &mp_type_property, + .proxy = {(mp_obj_t)&mcu_processor_get_uid_obj, // getter + (mp_obj_t)&mp_const_none_obj, // no setter + (mp_obj_t)&mp_const_none_obj, // no deleter + }, +}; + STATIC const mp_rom_map_elem_t mcu_processor_locals_dict_table[] = { { MP_ROM_QSTR(MP_QSTR_frequency), MP_ROM_PTR(&mcu_processor_frequency_obj) }, { MP_ROM_QSTR(MP_QSTR_temperature), MP_ROM_PTR(&mcu_processor_temperature_obj) }, + { MP_ROM_QSTR(MP_QSTR_uid), MP_ROM_PTR(&mcu_processor_uid_obj) }, }; STATIC MP_DEFINE_CONST_DICT(mcu_processor_locals_dict, mcu_processor_locals_dict_table); diff --git a/shared-bindings/microcontroller/Processor.h b/shared-bindings/microcontroller/Processor.h index a79dea478..28f054420 100644 --- a/shared-bindings/microcontroller/Processor.h +++ b/shared-bindings/microcontroller/Processor.h @@ -35,5 +35,6 @@ const mp_obj_type_t mcu_processor_type; uint32_t common_hal_mcu_processor_get_frequency(void); float common_hal_mcu_processor_get_temperature(void); +void common_hal_mcu_processor_get_uid(uint8_t raw_id[]); #endif // MICROPY_INCLUDED_SHARED_BINDINGS_MICROCONTROLLER_PROCESSOR_H -- cgit v1.2.3