Merge pull request #5557 from MikeDK/hal_cpu_uid

HAL API for CPU UID

Author: cmonr

drivers/DeviceUid.cpp

@@ -0,0 +1,70 @@
+/* mbed Microcontroller Library
+ * Copyright (c) 2017 ARM Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "hal/device_uid_api.h"
+#include "platform/mbed_assert.h"
+#include "platform/CriticalSectionLock.h"
+#include "drivers/DeviceUid.h"
+
+#if DEVICE_DEVICEUID
+
+namespace mbed {
+
+uint8_t DeviceUid::_uidbuf[MBED_DEVICEUID_SIZE] = {0};
+uint8_t* DeviceUid::_uidptr = NULL;
+char DeviceUid::_strbuf[DEVICEUID_STRING_BUFFER_SIZE] = {'\0'};
+char* DeviceUid::_strptr = NULL;
+#ifndef MBED_DEVICEUID_STR_SIZE_MAX
+const char DeviceUid::_hexChars[16] = {'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'};
+#endif
+
+DeviceUid::DeviceUid()
+{
+    populate_uid_buf();
+}
+
+void DeviceUid::populate_uid_buf()
+{
+    if (_uidptr == NULL) {
+        CriticalSectionLock lock;
+        device_uid_get_uid(_uidbuf);
+        _uidptr = _uidbuf;
+    }
+}
+
+void DeviceUid::populate_str_buf()
+{
+    if (_strptr == NULL) {
+        CriticalSectionLock lock;
+#ifdef MBED_DEVICEUID_STR_SIZE_MAX
+        device_uid_get_str(_strbuf);
+        _strptr = _strbuf;
+#else
+        int pos = 0;
+        populate_uid_buf();
+        for (int i = 0; i < MBED_DEVICEUID_SIZE; ++i) {
+            _strbuf[pos++] = _hexChars[_uidptr[i] >> 4];
+            _strbuf[pos++] = _hexChars[_uidptr[i] & 0x0F];
+        }
+        _strbuf[pos] = '\0';
+        _strptr = _strbuf;
+#endif
+    }
+}
+
+} // namespace mbed
+
+#endif

drivers/DeviceUid.h

@@ -0,0 +1,128 @@
+/* mbed Microcontroller Library
+ * Copyright (c) 2017 ARM Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+#ifndef MBED_DEVICEUID_H
+#define MBED_DEVICEUID_H
+
+#include "platform/platform.h"
+
+#if defined(DEVICE_DEVICEUID) || defined(DOXYGEN_ONLY)
+
+#ifdef MBED_DEVICEUID_STR_SIZE_MAX
+#define DEVICEUID_STRING_BUFFER_SIZE  MBED_DEVICEUID_STR_SIZE_MAX
+#else
+#define DEVICEUID_STRING_BUFFER_SIZE (MBED_DEVICEUID_SIZE * 2 + 1)
+#endif
+
+namespace mbed {
+/** \addtogroup drivers */
+
+/** DEVICE UID reader class
+ *
+ * @note Synchronization level: Interrupt safe
+ * @ingroup drivers
+ */
+class DeviceUid {
+public:
+    /** DeviceUid constructor
+     */
+    DeviceUid();
+    
+    /** Get size of DEVICE UID in bytes
+     * 
+     * @return Size of device's DEVICE UID in bytes
+     */
+    int size()
+    {
+        return MBED_DEVICEUID_SIZE;
+    }
+    
+    /** Get DEVICE UID data pointer
+     * 
+     * @return Pointer to uid data buffer
+     */
+    const uint8_t *data()
+    {
+        populate_uid_buf();
+        return _uidptr;
+    }
+    
+    /** Get DEVICE UID vendor string
+     * 
+     * @return Pointer to zero terminated uid vendor string
+     * 
+     * @note
+     * If vendor did not define MBED_DEVICEUID_STR_SIZE_MAX, DeviceUid driver will
+     * assume the HAL interface function device_uid_get_str() is not implemented
+     * on the target, and instead the driver will construct just an ASCII
+     * string out of the uid byte buffer contents.
+     * 
+     */
+    const char *c_str()
+    {
+        populate_str_buf();
+        return _strptr;
+    }
+    
+    /** Overload operator for byte pointer
+     * 
+     * @return Pointer to uid data buffer
+     */
+    operator const uint8_t*()
+    {
+        populate_uid_buf();
+        return _uidptr;
+    }
+    
+    operator const char*()
+    {
+        populate_str_buf();
+        return _strptr;
+    }
+
+    /** Overload operator for array subscript
+     * 
+     * @param x DEVICE UID Byte index
+     * 
+     * @return Byte located at index x
+     */
+    uint8_t operator[](int x)
+    {
+        if (x >= 0 && x < MBED_DEVICEUID_SIZE) {
+            populate_uid_buf();
+            return _uidptr[x];
+        }
+
+        return 0x00;
+    }
+    
+private:
+    void populate_uid_buf();
+    void populate_str_buf();
+    
+    static uint8_t _uidbuf[MBED_DEVICEUID_SIZE];
+    static uint8_t* _uidptr;
+    static char _strbuf[DEVICEUID_STRING_BUFFER_SIZE];
+    static char* _strptr;
+#ifndef MBED_DEVICEUID_STR_SIZE_MAX
+    static const char _hexChars[16];
+#endif
+};
+
+} // namespace mbed
+
+#endif
+
+#endif

hal/device_uid_api.h

@@ -0,0 +1,73 @@
+/** \addtogroup hal */
+/** @{*/
+/* mbed Microcontroller Library
+ * Copyright (c) 2017 ARM Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+#ifndef MBED_DEVICE_UID_API_H
+#define MBED_DEVICE_UID_API_H
+
+#include <stddef.h>
+#include "device.h"
+
+#if DEVICE_DEVICEUID
+
+#if !defined(MBED_DEVICEUID_SIZE) || (MBED_DEVICEUID_SIZE == 0)
+#error "DEVICE UID Vendor implementation must define macro MBED_DEVICEUID_SIZE with the non-zero uid size in bytes!"
+#endif
+
+#if !defined(MBED_DEVICEUID_STR_SIZE_MAX) || (MBED_DEVICEUID_STR_SIZE_MAX == 0)
+#warning "DEVICE UID max vendor string length not defined or zero! device_uid_get_str() HAL interface is disabled!"
+#endif
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * \defgroup hal_device_uid DEVICEUID hal functions
+ * @{
+ */
+
+/** Get DEVICE UID data bytes
+ * 
+ * @param uid Byte buffer for uid. Must be of size MBED_DEVICEUID_SIZE
+ *
+ */
+void device_uid_get_uid(uint8_t *uid);
+
+#ifdef MBED_DEVICEUID_STR_SIZE_MAX
+/** Get DEVICE UID vendor string
+ * 
+ * @param str Character buffer for vendor specific UID string. Must be of size MBED_DEVICEUID_STR_SIZE_MAX
+ * 
+ * @note
+ * Implementing this function on target side can be used to provide a vendor specific
+ * string describing the contents of the UID.
+ * The string length including terminating zero character must not exceed MBED_DEVICEUID_STR_SIZE_MAX bytes!
+ * 
+ */
+void device_uid_get_str(char *str);
+#endif
+
+/**@}*/
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif
+
+#endif
+/** @}*/

mbed.h

@@ -70,6 +70,7 @@
 #include "drivers/RawSerial.h"
 #include "drivers/UARTSerial.h"
 #include "drivers/FlashIAP.h"
+#include "drivers/DeviceUid.h"
 
 // mbed Internal components
 #include "drivers/Timer.h"

platform/CriticalSectionLock.h

@@ -19,6 +19,7 @@
 #define MBED_CRITICALSECTIONLOCK_H
 
 #include "platform/mbed_critical.h"
+#include "platform/mbed_toolchain.h"
 
 namespace mbed {
 

targets/TARGET_NORDIC/TARGET_NRF5/device_uid_api.c

@@ -0,0 +1,59 @@
+/* 
+ * Copyright (c) 2017 Nordic Semiconductor ASA
+ * All rights reserved.
+ * 
+ * Redistribution and use in source and binary forms, with or without modification,
+ * are permitted provided that the following conditions are met:
+ * 
+ *   1. Redistributions of source code must retain the above copyright notice, this list 
+ *      of conditions and the following disclaimer.
+ *
+ *   2. Redistributions in binary form, except as embedded into a Nordic Semiconductor ASA 
+ *      integrated circuit in a product or a software update for such product, must reproduce 
+ *      the above copyright notice, this list of conditions and the following disclaimer in 
+ *      the documentation and/or other materials provided with the distribution.
+ *
+ *   3. Neither the name of Nordic Semiconductor ASA nor the names of its contributors may be 
+ *      used to endorse or promote products derived from this software without specific prior 
+ *      written permission.
+ *
+ *   4. This software, with or without modification, must only be used with a 
+ *      Nordic Semiconductor ASA integrated circuit.
+ *
+ *   5. Any software provided in binary or object form under this license must not be reverse 
+ *      engineered, decompiled, modified and/or disassembled. 
+ * 
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ * 
+ */
+
+#include "device.h"
+
+#if DEVICE_DEVICEUID
+
+#include "nrf.h"
+#include "device_uid_api.h"
+
+#define UID_WORDS       2
+
+void device_uid_get_uid(uint8_t *uid)
+{
+    int pos = 0;
+
+    for (int i = (UID_WORDS-1); i >= 0; --i) {
+        for (int j = 3; j >= 0; --j) {
+            uid[pos++] = (uint8_t)((NRF_FICR->DEVICEID[i] >> (j*8)) & 0xFF);
+        }
+    }
+}
+
+#endif