sci_log.c File Reference

SCI: Command definitions for log messages in printf style. More...

#include "sci_cmd.h"
#include "sci_frame.h"
#include <stdarg.h>
#include "printf/printf.h"

Include dependency graph for sci_log.c:

Functions
static status_t	vprint (const char *fmt_s, va_list ap)
	A vprintf() function for the uart connection.
status_t	SCI_SendLogEntry (const char *fmt_s,...)
	Sends a log message.
status_t	print (const char *fmt_s,...)
	A printf-like function to print formatted data to an debugging interface.

Detailed Description

SCI: Command definitions for log messages in printf style.

This file provides an implementation for log messages/commands in the printf style of the C standard library that can be used along with the systems communication interface.

This file provides command definitions for the systems communication interface.

Copyright

Copyright (c) 2023, Broadcom Inc. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Function Documentation

vprint()

static status_t vprint ( const char *  fmt_s, va_list  ap  )

inlinestatic

A vprintf() function for the uart connection.

---

This function is similar to print except that, instead of taking a variable number of arguments directly, it takes an argument list pointer ap. Requires a call to va_start(ap, fmt_s); before and va_end(ap); after this function.

Parameters

fmt_s	The printf() format string.
ap	The argument list.

Returns

Returns the status (STATUS_OK on success).