sci_cmd.h File Reference

SCI Layer 3: Command (Message) Interface. More...

#include "sci.h"

Include dependency graph for sci_cmd.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	SCI_LOG_TIMESTAMP   1

Enumerations
enum	GenericSerialCommandCodes {   CMD_INVALID = 0x00 ,   CMD_PING = 0x01 ,   CMD_LOG_MESSAGE = 0x06 ,   CMD_STATUS_REPORT = 0x07 ,   CMD_SYSTEM_RESET = 0x08 ,   CMD_ACKNOWLEDGE = 0x0A ,   CMD_NOT_ACKNOWLEDGE = 0x0B ,   CMD_TEST_MESSAGE = 0x04 }

Functions
status_t	SCI_SendStatusReport (sci_device_t deviceID, status_t status)
	Sends an status report.
status_t	SCI_SendLogEntry (const char *fmt_s,...)
	Sends a log message.
status_t	SCI_Printf (const char *fmt_s,...)
	Sends a log message.

Detailed Description

SCI Layer 3: Command (Message) Interface.

This file provides an interface for the command or message layer of 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.