1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
RIOT/drivers/include/periph/cpuid.h
Ludwig Ortmann 5523ec67f3 doc: make peripheral interfaces modules
also remove `@file` parameters
2014-10-25 15:37:04 +02:00

55 lines
1.0 KiB
C

/*
* Copyright (C) 2014 Martin Lenders <mlenders@inf.fu-berlin.de>
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @defgroup driver_periph_cpuid CPUID
* @ingroup driver_periph
* @{
*
* @file
* @brief Provides access the CPU's serial number
*
* @author Martine Lenders <mlenders@inf.fu-berlin.de>
*/
#ifndef __PERIPH_CPUID_H_
#define __PERIPH_CPUID_H_
#include "cpu-conf.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* @def CPUID_ID_LEN
*
* @brief The length in byte of the CPU's serial number.
*
* @note Must be defined in the CPU's @ref cpu-conf.h
*/
#if CPUID_ID_LEN
/**
* @brief Gets the serial number of the CPU.
*
* @param[out] id The serial number of the CPU of length CPU_ID_LEN (must be
* defined in the CPU's cpu-conf.h)
*/
void cpuid_get(void *id);
#endif /* CPUID_ID_LEN */
#ifdef __cplusplus
}
#endif
#endif /* __PERIPH_CPUID_H_ */
/**
* @}
*/