-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Created Device Instance Info Provider (#18767)
The new Device Instance Info Provider provides API for accessing factory-provisioned device instance identifiers. All removed Configuration Manager method occurrences were replaced with a new Device Instance Info Provider API. Added LegacyDeviceInstanceInfoProvider implementation that preserves the existing ConfigurationManager methods.
- Loading branch information
1 parent
e7bb258
commit e023667
Showing
21 changed files
with
414 additions
and
179 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| /* | ||
| * | ||
| * Copyright (c) 2022 Project CHIP Authors | ||
| * | ||
| * 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. | ||
| */ | ||
| #pragma once | ||
|
|
||
| #include <lib/core/CHIPError.h> | ||
| #include <lib/support/Span.h> | ||
|
|
||
| namespace chip { | ||
| namespace DeviceLayer { | ||
|
|
||
| class DeviceInstanceInfoProvider | ||
| { | ||
| public: | ||
| DeviceInstanceInfoProvider() = default; | ||
| virtual ~DeviceInstanceInfoProvider() = default; | ||
|
|
||
| /** | ||
| * @brief Obtain the Serial Number from the device's factory data. | ||
| * | ||
| * The SerialNumber attribute specifies a human readable serial number | ||
| * | ||
| * @param[in, out] buf Buffer to copy string. | ||
| * On CHIP_NO_ERROR return from this function this buffer will be null-terminated. | ||
| * On error CHIP_ERROR_BUFFER_TOO_SMALL there is no guarantee that buffer will be null-terminated. | ||
| * @param[in] bufSize Size of data, including the null terminator, that can be written to buf. | ||
| * This size should be +1 higher than maximum possible string. | ||
| * @returns CHIP_NO_ERROR on success, or another CHIP_ERROR from the underlying implementation | ||
| * if access fails. | ||
| */ | ||
| virtual CHIP_ERROR GetSerialNumber(char * buf, size_t bufSize) = 0; | ||
|
|
||
| /** | ||
| * @brief Obtain a manufacturing date from the device's factory data. | ||
| * | ||
| * The ManufacturingDate attribute specifies the date that the Node was manufactured. | ||
| * Output values are returned in ISO 8601, where: | ||
| * The first month of the year is January and its returning value is equal to 1. | ||
| * The first day of a month starts from 1. | ||
| * | ||
| * @param[out] year Reference to location where manufacturing year will be stored | ||
| * @param[out] month 1-based value [range 1-12] Reference to location where manufacturing month will be stored | ||
| * @param[out] day 1-based value [range 1-31] Reference to location where manufacturing day will be stored | ||
| * @returns CHIP_NO_ERROR on success, or another CHIP_ERROR from the underlying implementation | ||
| * if access fails. | ||
| */ | ||
| virtual CHIP_ERROR GetManufacturingDate(uint16_t & year, uint8_t & month, uint8_t & day) = 0; | ||
|
|
||
| /** | ||
| * @brief Obtain a Hardware Version from the device's factory data. | ||
| * | ||
| * @param[out] hardwareVersion Reference to location where the hardware version integer will be copied | ||
| * @returns CHIP_NO_ERROR on success, or another CHIP_ERROR from the underlying implementation | ||
| * if access fails. | ||
| */ | ||
| virtual CHIP_ERROR GetHardwareVersion(uint16_t & hardwareVersion) = 0; | ||
|
|
||
| /** | ||
| * @brief Obtain a Hardware Version String from the device's factory data. | ||
| * | ||
| * The HardwareVersionString can be used to provide a more user-friendly value than that | ||
| * represented by the HardwareVersion attribute. | ||
| * | ||
| * @param[in, out] buf Buffer to copy string. | ||
| * On CHIP_NO_ERROR return from this function this buffer will be null-terminated. | ||
| * On error CHIP_ERROR_BUFFER_TOO_SMALL there is no guarantee that buffer will be null-terminated. | ||
| * @param[in] bufSize Size of data, including the null terminator, that can be written to buf. | ||
| * This size should be +1 higher than maximum possible string. | ||
| * @returns CHIP_NO_ERROR on success, CHIP_ERROR_BUFFER_TOO_SMALL if the buffer was too small to fit string and null | ||
| * terminating. or another CHIP_ERROR from the underlying implementation if access fails. | ||
| */ | ||
| virtual CHIP_ERROR GetHardwareVersionString(char * buf, size_t bufSize) = 0; | ||
|
|
||
| /** | ||
| * @brief Obtain a Rotating Device ID Unique ID from the device's factory data. | ||
| * | ||
| * The unique identifier consists of a randomly-generated 128-bit or longer octet string which | ||
| * was programmed during factory provisioning or delivered to the device by the vendor using | ||
| * secure means after a software update. | ||
| * | ||
| * @param[out] uniqueIdSpan Reference to location where the Rotating Device ID Unique ID will be copied | ||
| * According to specification input size of span buffer should be declared with at least 16 Bytes | ||
| * length The size of uniqueIdSpan is reduced to actual value on success | ||
| * @returns CHIP_NO_ERROR on success, or another CHIP_ERROR from the underlying implementation | ||
| * if access fails. | ||
| */ | ||
| virtual CHIP_ERROR GetRotatingDeviceIdUniqueId(MutableByteSpan & uniqueIdSpan) = 0; | ||
| }; | ||
|
|
||
| /** | ||
| * Instance getter for the global DeviceInstanceInfoProvider. | ||
| * | ||
| * Callers have to externally synchronize usage of this function. | ||
| * | ||
| * @return The pointer to global device instance info provider. Assume never null. | ||
| */ | ||
| DeviceInstanceInfoProvider * GetDeviceInstanceInfoProvider(); | ||
|
|
||
| /** | ||
| * Instance setter for the global DeviceInstanceInfoProvider. | ||
| * | ||
| * Callers have to externally synchronize usage of this function. | ||
| * | ||
| * If the `provider` is nullptr, no change is done. | ||
| * | ||
| * @param[in] provider the DeviceInstanceInfoProvider pointer to start returning with the getter | ||
| */ | ||
| void SetDeviceInstanceInfoProvider(DeviceInstanceInfoProvider * provider); | ||
|
|
||
| } // namespace DeviceLayer | ||
| } // namespace chip |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.