sci_datalink.h File Reference

SCI Layer 2: Data Link Interface. More...

#include "sci_status.h"
#include "sci_internal_types.h"

Include dependency graph for sci_datalink.h:

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

Go to the source code of this file.

Macros
#define	SCI_ALLOW_NEWLINE   1
	Whether to allow newline ( ) in print / log messages.
#define	SCI_CMD_IS_EXTENDED_CMD(cmd)   ((cmd) & 0x80)
	Checks whether the command byte is an extended command (= MSB set).

Functions
status_t	SCI_DataLink_Init (void)
	Initialize the data link module.
status_t	SCI_DataLink_CheckRxFrame (sci_frame_t *frame)
	Checks the CRC checksum for a RX frame.
void	SCI_DataLink_ReleaseFrames (sci_frame_t *frame)
	Releases the frame queue.
void	SCI_DataLink_ResetRxFrames (sci_frame_t *frame)
	Resets the frame read pointer to the very first byte (= command byte).
bool	SCI_DataLink_IsTxBusy (void)
	Returns whether the TX line is currently busy and data is being sent.
status_t	SCI_DataLink_SendTxFrame (sci_frame_t *frame, bool high_priority)
	Trigger the data transfer and releases the TX buffers.
sci_frame_t *	SCI_DataLink_RequestTxFrame (bool queueStartByte)
	Find an unused TX buffer from the queue and prepare it with a start byte.

Detailed Description

SCI Layer 2: Data Link Interface.

This file provides an interface for the data link 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.