mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-08-15 21:46:10 +00:00
46f108519d
Add the hwinfo API to the reference documentation. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
62 lines
1.3 KiB
C
62 lines
1.3 KiB
C
/**
|
|
* @file
|
|
*
|
|
* @brief Public APIs to get device Information.
|
|
*/
|
|
|
|
/*
|
|
* Copyright (c) 2018 Alexander Wachter
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
#ifndef ZEPHYR_INCLUDE_DRIVERS_HWINFO_H_
|
|
#define ZEPHYR_INCLUDE_DRIVERS_HWINFO_H_
|
|
|
|
/**
|
|
* @brief Hardware Information Interface
|
|
* @defgroup hwinfo_interface Hardware Info Interface
|
|
* @ingroup io_interfaces
|
|
* @{
|
|
*/
|
|
|
|
#include <zephyr/types.h>
|
|
#include <sys/types.h>
|
|
#include <stddef.h>
|
|
#include <errno.h>
|
|
#include <kernel.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @brief Copy the device id to a buffer
|
|
*
|
|
* This routine copies "length" number of bytes of the device ID to the buffer.
|
|
* If the device ID is smaller then length, the rest of the buffer is left unchanged.
|
|
* The ID depends on the hardware and is not guaranteed unique.
|
|
*
|
|
* @param buffer Buffer to write the ID to.
|
|
* @param length Max length of the buffer.
|
|
*
|
|
* @retval size of the device ID copied.
|
|
* @retval -ENOTSUP if there is no implementation for the particular device.
|
|
* @retval any negative value on driver specific errors.
|
|
*/
|
|
__syscall ssize_t hwinfo_get_device_id(u8_t *buffer, size_t length);
|
|
|
|
ssize_t z_impl_hwinfo_get_device_id(u8_t *buffer, size_t length);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#include <syscalls/hwinfo.h>
|
|
|
|
#endif /* ZEPHYR_INCLUDE_DRIVERS_HWINFO_H_ */
|