qs_port.h

Go to the documentation of this file.

//! @file
//! @brief Sample QS/C port
//!
//! @code_litem{Details}
//! This is just an example of a QS port for a 32-bit CPU.
//! Other specific QS ports will define the QS facilities differently.
//!
//! @remark
//! QS might be used with or without the other %QP Framework components,
//! in which case the separate definitions of the macros QS_CRIT_STAT,
//! QS_CRIT_ENTRY(), and QS_CRIT_EXIT() are needed. In this sample port QS is
//! configured to be used with the other QP component, by simply including
//! "qp_port.h" *before* "qs.h".
 
#ifndef QS_PORT_H_
#define QS_PORT_H_
 
/*! @brief object pointer size in bytes (depends on the CPU)
 
@code_litem{Details}
- 2U => 2 bytes
- 4U => 4 bytes (default)
- 8U => 8 bytes
 
@note
#QS_OBJ_PTR_SIZE depends on the CPU/Compiler and is defined in `qs_port.h`. It cannot be overridden in `qp_config.h`.
*/
#define QS_OBJ_PTR_SIZE  4U
 
/*! @brief function pointer size in bytes (depends on the CPU)
 
@code_litem{Details}
- 2U => 2 bytes
- 4U => 4 bytes (default)
- 8U => 8 bytes
 
@note
#QS_FUN_PTR_SIZE depends on the CPU/Compiler and is defined in `qs_port.h`. It cannot be overridden in `qp_config.h`.
*/
#define QS_FUN_PTR_SIZE  4U
 
// NOTE: QS might be used with or without other QP components, in which
// case the separate definitions of the macros QF_CRIT_STAT, QF_CRIT_ENTRY(),
// and QF_CRIT_EXIT() are needed. In this port QS is configured to be used
// with the other QP component, by simply including "qp_port.h"
// *before* "qs.h".
#ifndef QP_PORT_H_
#include "qp_port.h" // use QS with QF
#endif
 
#include "qs.h"      // QS platform-independent public interface
 
#endif // QS_PORT_H_