qs_pkg.h File Reference

Internal (package scope) QS/C++ interface. More...

#include "qs_port.h"

Go to the source code of this file.

Defines
#define	QS_INSERT_BYTE(b_)
	Internal QS macro to insert an un-escaped byte into the QS buffer.
#define	QS_INSERT_ESC_BYTE(b_)
	Internal QS macro to insert an escaped byte into the QS buffer.
#define	QS_INSERT_CHKSUM_BYTE()
	Internal QS macro to insert a escaped checksum byte into the QS buffer.
#define	QS_FRAME   ((uint8_t)0x7E)
	Frame character of the QS output protocol.
#define	QS_ESC   ((uint8_t)0x7D)
	Escape character of the QS output protocol.
#define	QS_ESC_XOR   0x20
	Escape modifier of the QS output protocol.
Typedefs
typedef uint16_t	QSCtr
	QS ring buffer counter and offset type.
Variables
uint8_t *	QS_ring_
	pointer to the start of the ring buffer
QSCtr	QS_end_
	offset of the end of the ring buffer
QSCtr	QS_head_
	offset to where next byte will be inserted
QSCtr	QS_tail_
	offset of where next event will be extracted
QSCtr	QS_used_
	number of bytes currently in the ring buffer
uint8_t	QS_seq_
	the record sequence number
uint8_t	QS_chksum_
	the checksum of the current record
uint8_t	QS_full_
	the ring buffer is temporarily full

---

Detailed Description

Internal (package scope) QS/C++ interface.

Definition in file qs_pkg.h.

---

Define Documentation

#define QS_ESC_XOR   0x20

Escape modifier of the QS output protocol.

The escaped byte is XOR-ed with the escape modifier before it is inserted into the QS buffer.

Definition at line 89 of file qs_pkg.h.