sci_frame.h File Reference

SCI Data Frame Interface. More...

#include "sci_internal_types.h"
#include "utility/time.h"

Include dependency graph for sci_frame.h:

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

Go to the source code of this file.

Functions
int32_t	SCI_Frame_TotalFrameLength (sci_frame_t const *frame)
	Returns the total number of bytes within a specified frame.
uint8_t	SCI_Frame_IsStartFrame (sci_frame_t const *frame)
	Determines whether the frame is a start frame.
uint32_t	SCI_Frame_BytesToRead (sci_frame_t const *frame)
	Returns the bytes that have been written from the buffer and not read yet.
void	SCI_Frame_PutChar (char c, void *frame)
	Inserts a char into the TX buffer.
void	SCI_Frame_SetByte (sci_frame_t *frame, uint8_t byte)
	Function for inserting a byte in a SCI frame.
void	SCI_Frame_Queue08s (sci_frame_t *frame, int8_t data)
	Inserts a signed byte (8-bit) into the TX buffer.
void	SCI_Frame_Queue16s (sci_frame_t *frame, int16_t data)
	Inserts a signed halfword (16-bit) into the TX buffer.
void	SCI_Frame_Queue24s (sci_frame_t *frame, int32_t data)
	Inserts a signed 3/4-word (24-bit) into the TX buffer.
void	SCI_Frame_Queue32s (sci_frame_t *frame, int32_t data)
	Inserts a signed word (32-bit) into the TX buffer.
void	SCI_Frame_Queue_Time (sci_frame_t *frame, ltc_t const *t)
	Inserts a ltc_t time stamp type into the TX buffer.
void	SCI_Frame_Queue08u (sci_frame_t *frame, uint8_t data)
	Inserts a unsigned byte (8-bit) into the TX buffer.
void	SCI_Frame_Queue16u (sci_frame_t *frame, uint16_t data)
	Inserts a unsigned halfword (16-bit) into the TX buffer.
void	SCI_Frame_Queue24u (sci_frame_t *frame, uint32_t data)
	Inserts a unsigned 3/4-word (24-bit) into the TX buffer.
void	SCI_Frame_Queue32u (sci_frame_t *frame, uint32_t data)
	Inserts a unsigned word (32-bit) into the TX buffer.
int8_t	SCI_Frame_Dequeue08s (sci_frame_t *frame)
	Takes a signed byte (8-bit) from the RX buffer.
int16_t	SCI_Frame_Dequeue16s (sci_frame_t *frame)
	Takes a signed halfword (16-bit) from the RX buffer.
int32_t	SCI_Frame_Dequeue24s (sci_frame_t *frame)
	Takes a signed 3/4-word (24-bit) from the RX buffer.
int32_t	SCI_Frame_Dequeue32s (sci_frame_t *frame)
	Takes a signed word (32-bit) from the RX buffer.
uint8_t	SCI_Frame_Dequeue08u (sci_frame_t *frame)
	Takes a unsigned byte (8-bit) from the RX buffer.
uint16_t	SCI_Frame_Dequeue16u (sci_frame_t *frame)
	Takes a unsigned halfword (16-bit) from the RX buffer.
uint32_t	SCI_Frame_Dequeue24u (sci_frame_t *frame)
	Takes a unsigned 3/4-word (24-bit) from the RX buffer.
uint32_t	SCI_Frame_Dequeue32u (sci_frame_t *frame)
	Takes a unsigned word (32-bit) from the RX buffer.

Detailed Description

SCI Data Frame Interface.

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