include/rtems/dumpbuf.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @brief Print a Memory Buffer
0007  *
0008  * This file defines the interface to the RTEMS methods to print a
0009  * memory buffer in a style similar to many ROM monitors and debuggers.
0010  */
0011
0012 /*
0013  * COPYRIGHT (c) 1997-2011.
0014  * On-Line Applications Research Corporation (OAR).
0015  *
0016  * Redistribution and use in source and binary forms, with or without
0017  * modification, are permitted provided that the following conditions
0018  * are met:
0019  * 1. Redistributions of source code must retain the above copyright
0020  *    notice, this list of conditions and the following disclaimer.
0021  * 2. Redistributions in binary form must reproduce the above copyright
0022  *    notice, this list of conditions and the following disclaimer in the
0023  *    documentation and/or other materials provided with the distribution.
0024  *
0025  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0026  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0027  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0028  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0029  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0030  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0031  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0032  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0033  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0034  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0035  * POSSIBILITY OF SUCH DAMAGE.
0036  */
0037
0038 #ifndef __DUMP_BUFFER_h
0039 #define __DUMP_BUFFER_h
0040
0041 /**
0042  *  @defgroup libmisc_dumpbuf Print Memory Buffer
0043  *
0044  *  @ingroup RTEMSAPIPrintSupport
0045  */
0046 /**@{*/
0047 #ifdef __cplusplus
0048 extern "C" {
0049 #endif
0050
0051 /**
0052  * @brief Print memory buffer.
0053  *
0054  * This method prints @a length bytes beginning at @a buffer in
0055  * a nice format similar to what one would expect from a debugger
0056  * or ROM monitor.
0057  *
0058  * @param[in] buffer is the address of the buffer
0059  * @param[in] length is the length of the buffer
0060  */
0061 void rtems_print_buffer(
0062   const unsigned char *buffer,
0063   int                  length
0064 );
0065
0066 #ifdef __cplusplus
0067 }
0068 #endif
0069 /**@}*/
0070 #endif
0071 /* end of include file */