1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
RIOT/sys/include/od.h
Martine Lenders 2db9ed11d1 od: simplify od module to only provide od_hex_dump
To my knowledge no one was using the more complex functionalities of
this module (except for the test application and pktbuf which just used
the same flags as the `od_hex_dump()` wrapper), so why not reduce the
functionality of this module?
2017-03-28 19:14:59 +02:00

52 lines
1.1 KiB
C

/*
* Copyright (C) 2014 Martine 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 sys_od Object dump
* @ingroup sys
* @brief Allows to print out data dumps of memory regions
*
* @{
*
* @file
*
* @author Martine Lenders <mlenders@inf.fu-berlin.de>
*/
#ifndef OD_H
#define OD_H
#ifdef __cplusplus
extern "C" {
#endif
#include <stddef.h>
#include <stdint.h>
/**
* @brief Default value for parameter *width* of @ref od_hex_dump()
*/
#define OD_WIDTH_DEFAULT (16)
/**
* @brief Dumps memory stored at *data* byte-wise up to *data_len* in
* hexadecimal representation to stdout with
*
* @param[in] data Data to dump.
* @param[in] data_len Length in bytes of *data* to output.
* @param[in] width Number of bytes per line. If *width* is 0,
* @ref OD_WIDTH_DEFAULT is assumed as a default value.
*/
void od_hex_dump(const void *data, size_t data_len, uint8_t width);
#ifdef __cplusplus
}
#endif
#endif /* OD_H */
/** @} */