qualcomm/qbox
Loading...
Searching...
No Matches
gs Namespace Reference

Tool which reads a Lua configuration file and sets parameters. More...

Classes

class  biflow_router
class  async_event
class  container_module
class  cci_function
 Basic function container for CCI Packing and unpacking are not supported. More...
class  cci_function< T(U...)>
class  cci_constructor_vl
 sc_module constructor container for CCI This uses the CCI Function container, and the FactoryMaker in order to parameterise the constructor and maintain type safety The actual parameters will be extracted (in a type safe manor) from a CCI list More...
class  HelpSingleton
class  ConfigurableBroker
 Configurable Broker class, inherits from the 'standard' cci_utils broker, but adds 1/ The ability to be instanced in the constructor 2/ The ability to automatically load a configuration file 3/ Explicitly set parameters (from the constructor) are 'hidden' from the parent broker. More...
class  PrivateConfigurableBroker
class  elf_loader
 ELF file loader. More...
class  fss_binder_if
class  fss_binder_base
class  fss_events_binder
class  fss_time_sync_binder
class  fss_data_binder
class  fss_control_binder
class  inlinesync
class  CSVRow
class  loader
class  LuaFile_Tool
struct  AllocatedMemory
struct  NameRegistry
 Structure to hold an array of names for shared memory usage. More...
class  ShmemCleanerService
class  SharedMemoryCleaner
 Forks a process to ensure shared memory cleanup on crash or abnormal exit. More...
class  MemoryServices
class  observer_event
struct  biflow_bindable
struct  biflow_multibindable
class  biflow_socket
class  biflow_router_socket
class  biflow_socket_multi
class  global_pause
class  tlm_quantumkeeper_extended
class  tlm_quantumkeeper_multi_adaptive
class  tlm_quantumkeeper_freerunning
class  tlm_quantumkeeper_multi_quantum
class  tlm_quantumkeeper_multi_rolling
class  tlm_quantumkeeper_unconstrained
class  tlm_quantumkeeper_multithread
class  json_zip_archive
class  base_components
class  json_module_base
class  json_module
class  json_module_top
struct  gs_bank_of
struct  is_gs_bank
struct  is_gs_bank< gs_bank_of< E > >
struct  gs_bank_access
class  tlm_fnct
 Provide a class to provide b_transport callback. More...
class  port_fnct
 A class that encapsulates a simple target port and a set of b_transport lambda functions for pre/post read/write. when b_transport is called port, the correct lambda's will be invoked. More...
class  proxy_data_array
 A proxy data class that stores it's value using a b_transport interface Data is passed by pointer, array indexing (operator[]) is supported. More...
class  proxy_data
 A proxy data class that stores it's value using a b_transport interface Data is passed by value. More...
class  gs_bitfield
 Proxy for bitfield access to a register. More...
class  gs_field
 fields within registered encapsulated using a bitfield proxy. This field is constructed from a specific bit field in a specific register. The bitfield itself may be re-used to use the same field in another register. More...
class  gs_register_element
class  gs_register
 Class that encapsulates a 'register' that proxies it's data via a tlm interface, and uses callbacks (on a tlm interface). More...
class  gs_register_bank_element
class  gs_register< gs_bank_of< ELEM > >
class  PassRPC
class  LocalPass
class  RemotePass
class  router_if
class  runonsysc
class  semaphore
class  PathIDExtension
class  QemuMemTxAttrTlmExtension
class  ShmemIDExtension
class  tlm_dmi_ex
class  UnderlyingDMITlmExtension
class  transaction_forwarder_if
class  SigHandler
class  ProcAliveHandler
struct  elf32_traits
struct  elf64_traits
class  component_constructor
class  container_builder
class  dmi_converter
struct  generic_lua_model_signal_payload
struct  generic_lua_model_txn_payload
class  generic_lua_model
class  gs_memory
 A gs_memory component that can add memory to a virtual platform project. More...
class  memory_dumper
class  monitor
class  pass
class  pll
class  generic_payload_data_buf
class  generic_payload_be_buf
class  tlm_generic_payload_wrapper
class  PyInterpreterManager
class  python_binder
class  reg_router
class  LRUCache
class  RegionFIFOCache
 RegionFIFOCache - A simple FIFO cache for region-based address lookups. More...
class  RegionLRUCache
 RegionLRUCache - A true LRU cache for region-based address lookups. More...
class  AddrMapCacheBase
class  AddrMapNoCache
 AddrMapNoCache - A cache implementation that never caches (always misses). More...
class  router
 A SystemC TLM router module for transaction routing based on address. More...
class  smmu500_transaction_attrs_extension
class  smmu500_tbu
class  smmu500
class  smmu500_gen
class  smmuv3_tbu
class  smmuv3
class  smmuv3_ss_extension
class  smmuv3_ats_extension
class  smmuv3_gen
class  smmuv3_memory_attrs_extension
class  tlm_bus_width_bridges
class  wdog
class  write_gpio

Typedefs

template<typename T>
using BIND_IF_FN_PTR = fssRetStatus (*)(fssBindIFHandle, fssString, T*)
template<typename T>
using GET_IF_FN_PTR = T* (*)(fssBindIFHandle, fssString)
using QemuMemTxSecureTlmExtension = QemuMemTxAttrTlmExtension<QemuMemTxSecureAttrTag, bool>
using QemuMemTxSpaceTlmExtension = QemuMemTxAttrTlmExtension<QemuMemTxSpaceAttrTag, QemuSecuritySpace>
using QemuMemTxUserTlmExtension = QemuMemTxAttrTlmExtension<QemuMemTxUserAttrTag, bool>
using QemuMemTxMemoryTlmExtension = QemuMemTxAttrTlmExtension<QemuMemTxMemoryAttrTag, bool>
using QemuMemTxDebugTlmExtension = QemuMemTxAttrTlmExtension<QemuMemTxDebugAttrTag, bool>
using QemuMemTxRequesterIdTlmExtension = QemuMemTxAttrTlmExtension<QemuMemTxRequesterIdAttrTag, uint16_t>
using QemuMemTxPidTlmExtension = QemuMemTxAttrTlmExtension<QemuMemTxPidAttrTag, uint8_t>
using QemuMemTxAddressTypeTlmExtension = QemuMemTxAttrTlmExtension<QemuMemTxAddressTypeAttrTag, bool>
using QemuMemTxUnspecifiedTlmExtension = QemuMemTxAttrTlmExtension<QemuMemTxUnspecifiedAttrTag, bool>

Enumerations

enum class  QemuSecuritySpace : uint8_t { Secure = 0 , NonSecure = 1 , Root = 2 , Realm = 3 }
enum  ForwarderType { CONTAINER , PASS , SC_MODULE }
enum class  Handler_CB {
  EXIT , PASS , FORCE_EXIT , IGN ,
  DFL
}
enum class  py_wait_type { SC_TIME , SC_EVENT , GS_ASYNC_EVENT , TIMED_SC_EVENT }
enum class  IOMMUAccessFlags : uint8_t { NONE = 0 , RO = 1 , WO = 2 , RW = 3 }

Functions

sc_core::sc_object * find_sc_obj (sc_core::sc_object *m, std::string name, bool test=false)
 Helper function to find a sc_object by fully qualified name throws SC_ERROR if nothing found.
template<typename T>
std::vector< T * > find_sc_objects (sc_core::sc_object *m=nullptr)
 Helper function to find a sc_objects of a given type.
std::string sc_cci_leaf_name (std::string name)
 return the leaf name of the given systemc hierarchical name
std::list< std::string > sc_cci_children (sc_core::sc_module_name name)
 return a list of 'unconsumed' children from the given module name, can be used inside or outside the heirarchy
std::list< std::string > sc_cci_list_items (sc_core::sc_module_name module_name, std::string list_name)
 return a list of 'unconsumed' items in the module matching the base name given, plus '_' and a numeric value typically this would be a list of items from an sc_vector Can be used inside or outside the heirarchy
std::string get_parent_name (sc_core::sc_module_name n)
cci::cci_value cci_get (cci::cci_broker_handle broker, std::string name)
template<typename T>
T cci_get (cci::cci_broker_handle broker, std::string name)
template<typename T>
T cci_get_d (cci::cci_broker_handle broker, std::string name, T default_val)
template<typename T>
bool cci_get (cci::cci_broker_handle broker, std::string name, T &param)
void cci_clear_unused (cci::cci_broker_handle broker, std::string name)
template<typename T>
std::vector< T > cci_get_vector (cci::cci_broker_handle broker, const std::string base)
std::vector< uint8_t > dtb_build (const std::string &base, const std::vector< std::string > &overlays, std::string &error)
 Build a flattened device tree from a base DTB and ordered overlays.
template<class PARENT_TYPE, class MEMBER_TYPE>
PARENT_TYPE * container_of (const MEMBER_TYPE *member, const MEMBER_TYPE PARENT_TYPE::*member_ptr)
void die_null_ptr (const std::string &fn_name, const std::string &ptr_name)
std::shared_ptr< gs::tlm_quantumkeeper_extended > tlm_quantumkeeper_factory (std::string name)
zip_t * zip_open_from_memory (const void *data, std::size_t size)
std::vector< uint8_t > zip_extract (zip_t *archive, const std::string &archive_name, const std::string &file_name="", uint64_t file_offset=0, uint64_t file_data_len=0)
 Extract data from a zip archive.
std::vector< uint8_t > zip_extract_nested (zip_t *archive, const std::string &archive_name, const std::string &compressed_file_name, const std::string &inner_file_name, uint64_t file_offset=0, uint64_t file_data_len=0)
 Extract compressed data from a nested zip archive.
template<typename T>
std::vector< T > & join (std::vector< T > &vector1, const std::vector< T > &vector2)
template<typename T>
std::vector< std::string > find_object_of_type (sc_core::sc_object *m=NULL)
void memorydumper_tgr_helper ()
std::vector< crow::json::wvalue > json_cci_params (sc_core::sc_object *obj)
crow::json::wvalue object_to_json (sc_core::sc_object *obj)
crow::json::wvalue json_object (sc_core::sc_object *obj)
unsigned char * get_pybind11_buffer_info_ptr (const pybind11::buffer &bytes)
std::string txn_command_str (const tlm::tlm_generic_payload &trans)
bool sc_thread_try_wait (pybind11::object obj, py_wait_type type)
void exec_sc_thread_try_wait (pybind11::object obj, bool notify=false, std::shared_ptr< sc_core::sc_event > notifier=nullptr)
 PYBIND11_EMBEDDED_MODULE (sc_core, m)
 PYBIND11_EMBEDDED_MODULE (gs, m)
 PYBIND11_EMBEDDED_MODULE (tlm_generic_payload, m)
 SC_MODULE (realtimelimiter)
 realtimelimiter: sc_module which suspends SystemC if SystemC time drifts ahead of realtime
const void * smmuv3_zip_archive_data () noexcept
unsigned int smmuv3_zip_archive_size () noexcept
constexpr IOMMUAccessFlags operator& (IOMMUAccessFlags a, IOMMUAccessFlags b)
constexpr IOMMUAccessFlags operator| (IOMMUAccessFlags a, IOMMUAccessFlags b)
constexpr IOMMUAccessFlags operator~ (IOMMUAccessFlags a)
IOMMUAccessFlags & operator&= (IOMMUAccessFlags &a, IOMMUAccessFlags b)
IOMMUAccessFlags & operator|= (IOMMUAccessFlags &a, IOMMUAccessFlags b)

Variables

global_pause gp
unsigned int gp_ref_count = 0
constexpr uint64_t SMMUV3_PAGESIZE = 4096
constexpr uint64_t SMMUV3_PAGEMASK = SMMUV3_PAGESIZE - 1
constexpr uint32_t SMMUV3_MAX_TBU = 16
constexpr size_t SMMUV3_STE_SIZE = 64
constexpr size_t SMMUV3_CD_SIZE = 64
constexpr size_t SMMUV3_CMD_SIZE = 16
constexpr size_t SMMUV3_EVENT_SIZE = 32
constexpr size_t SMMUV3_PRI_SIZE = 16
constexpr uint32_t SMMUV3_EVT_F_UUT = 0x01
constexpr uint32_t SMMUV3_EVT_C_BAD_STREAMID = 0x02
constexpr uint32_t SMMUV3_EVT_F_STE_FETCH = 0x03
constexpr uint32_t SMMUV3_EVT_C_BAD_STE = 0x04
constexpr uint32_t SMMUV3_EVT_C_BAD_SUBSTREAMID = 0x08
constexpr uint32_t SMMUV3_EVT_F_CD_FETCH = 0x09
constexpr uint32_t SMMUV3_EVT_C_BAD_CD = 0x0A
constexpr uint32_t SMMUV3_EVT_F_WALK_EABT = 0x0B
constexpr uint32_t SMMUV3_EVT_F_TRANSLATION = 0x10
constexpr uint32_t SMMUV3_EVT_F_ADDR_SIZE = 0x11
constexpr uint32_t SMMUV3_EVT_F_ACCESS = 0x12
constexpr uint32_t SMMUV3_EVT_F_PERMISSION = 0x13
constexpr uint32_t SMMUV3_EVT_F_STALL = 0x29
constexpr uint8_t SMMUV3_CERROR_NONE = 0
constexpr uint8_t SMMUV3_CERROR_ILL = 1
constexpr uint8_t SMMUV3_CERROR_ABT = 2
constexpr uint8_t SMMUV3_CERROR_ATC_INV_SYNC = 3
constexpr uint32_t SMMUV3_CLASS_TT = 0
constexpr uint32_t SMMUV3_CLASS_IN = 1
constexpr uint32_t SMMUV3_CLASS_CD = 2
constexpr uint32_t EVT_W0_TYPE_MASK = 0xFFu
constexpr uint32_t EVT_W0_SSV_BIT = 12
constexpr uint32_t EVT_W0_SSID_SHIFT = 13
constexpr uint32_t EVT_W0_SSID_MASK = 0xFFFFFu
constexpr uint32_t EVT_W0_STREAMID_SHIFT = 32
constexpr uint32_t EVT_W1_STAG_MASK = 0xFFFFu
constexpr uint32_t EVT_W1_RNW_BIT = 17
constexpr uint32_t EVT_W1_CLASS_SHIFT = 20
constexpr uint32_t EVT_W1_CLASS_MASK = 0x3u
constexpr uint32_t EVT_W1_STALL_BIT = 23
constexpr uint32_t EVT_W1_REASON_SHIFT = 24
constexpr uint32_t EVT_W1_REASON_MASK = 0x7u
constexpr uint32_t GERROR_BIT_MSI_CMDQ_ABT = 4
constexpr uint32_t GERROR_BIT_MSI_EVENTQ_ABT = 5
constexpr uint32_t GERROR_BIT_MSI_PRIQ_ABT = 6
constexpr uint32_t GERROR_BIT_MSI_GERROR_ABT = 7
constexpr uint32_t S1FMT_LINEAR = 0
constexpr uint32_t S1FMT_4KB_L2 = 1
constexpr uint32_t S1FMT_64KB_L2 = 2
constexpr uint32_t S1FMT_4KB_L2_SPLIT = 4
constexpr uint32_t S1FMT_64KB_L2_SPLIT = 8
constexpr uint32_t DESC_BIT_AF = 10
constexpr uint32_t DESC_BIT_DBM = 51
constexpr uint32_t STE_CONFIG_ABORT = 0
constexpr uint32_t STE_CONFIG_BYPASS = 4
constexpr uint32_t STE_CONFIG_S1 = 5
constexpr uint32_t STE_CONFIG_S2 = 6
constexpr uint32_t STE_CONFIG_NESTED = 7
constexpr uint8_t CD_TG_4K = 0
constexpr uint8_t CD_TG_64K = 1
constexpr uint8_t CD_TG_16K = 2
constexpr uint8_t TLBI_TG_DC = 0
constexpr uint8_t TLBI_TG_4K = 1
constexpr uint8_t TLBI_TG_16K = 2
constexpr uint8_t TLBI_TG_64K = 3
constexpr uint32_t PAGE_SHIFT_4K = 12
constexpr uint32_t PAGE_SHIFT_16K = 14
constexpr uint32_t PAGE_SHIFT_64K = 16
constexpr uint32_t GRAINSIZE_4K = 12
constexpr uint32_t GRAINSIZE_16K = 14
constexpr uint32_t GRAINSIZE_64K = 16
constexpr uint32_t STRIDE_4K = 9
constexpr uint32_t STRIDE_16K = 11
constexpr uint32_t STRIDE_64K = 13
constexpr uint32_t GERROR_BIT_CMDQ_ERR = 0
constexpr uint32_t GERROR_BIT_EVENTQ_ABT = 2
constexpr uint32_t GERROR_BIT_PRIQ_ABT = 3
constexpr uint32_t GERROR_BIT_SFM_ERR = 8
constexpr uint32_t DESC_TYPE_INVALID = 0
constexpr uint32_t DESC_TYPE_BLOCK = 1
constexpr uint32_t DESC_TYPE_RESERVED = 2
constexpr uint32_t DESC_TYPE_TABLE_OR_PAGE = 3
constexpr uint32_t DESC_ATTR_AP1_BIT = 4
constexpr uint32_t DESC_ATTR_AP2_BIT = 5
constexpr uint32_t DESC_ATTR_AF_BIT = 8
constexpr uint32_t S2AP_NONE = 0
constexpr uint32_t S2AP_RO = 1
constexpr uint32_t S2AP_WO = 2
constexpr uint32_t S2AP_RW = 3
constexpr uint64_t STE_BASE_ADDR_MASK = 0x000FFFFFFFFFFFC0ULL
constexpr uint64_t S2TTB_ADDR_MASK = 0x000FFFFFFFFFFFF0ULL
constexpr uint64_t IPA_ADDR_MASK = 0x000FFFFFFFFFF000ULL
constexpr uint64_t CMDQ_BASE_HI_MASK = 0x000FFFFFULL
constexpr uint8_t CMD_OP_PREFETCH_CONFIG = 0x01
constexpr uint8_t CMD_OP_PREFETCH_ADDR = 0x02
constexpr uint8_t CMD_OP_CFGI_STE = 0x03
constexpr uint8_t CMD_OP_CFGI_STE_RANGE = 0x04
constexpr uint8_t CMD_OP_CFGI_CD = 0x05
constexpr uint8_t CMD_OP_CFGI_CD_ALL = 0x06
constexpr uint8_t CMD_OP_CFGI_ALL = 0x07
constexpr uint8_t CMD_OP_TLBI_NH_ALL = 0x10
constexpr uint8_t CMD_OP_TLBI_NH_ASID = 0x11
constexpr uint8_t CMD_OP_TLBI_NH_VA = 0x12
constexpr uint8_t CMD_OP_TLBI_NH_VAA = 0x13
constexpr uint8_t CMD_OP_TLBI_EL3_ALL = 0x18
constexpr uint8_t CMD_OP_TLBI_EL3_VA = 0x1A
constexpr uint8_t CMD_OP_TLBI_EL2_ALL = 0x20
constexpr uint8_t CMD_OP_TLBI_EL2_ASID = 0x21
constexpr uint8_t CMD_OP_TLBI_EL2_VA = 0x22
constexpr uint8_t CMD_OP_TLBI_EL2_VAA = 0x23
constexpr uint8_t CMD_OP_TLBI_S12_VMALL = 0x28
constexpr uint8_t CMD_OP_TLBI_S2_IPA = 0x2A
constexpr uint8_t CMD_OP_TLBI_NSNH_ALL = 0x30
constexpr uint8_t CMD_OP_ATC_INV = 0x40
constexpr uint8_t CMD_OP_PRI_RESP = 0x41
constexpr uint8_t CMD_OP_RESUME = 0x44
constexpr uint8_t CMD_OP_STALL_TERM = 0x45
constexpr uint8_t CMD_OP_SYNC = 0x46
constexpr uint32_t SYNC_CS_NONE = 0
constexpr uint32_t SYNC_CS_IRQ = 1
constexpr uint32_t SYNC_CS_SEV = 2
constexpr uint32_t GATOS_PAR_FAULT_TRANSLATION = 0x10
constexpr uint32_t IDR0_TTF_AARCH64 = 0x2
constexpr uint32_t IDR0_STLEVEL_2LVL = 0x2
constexpr uint32_t IDR1_DEFAULT_QUEUE_LOG2 = 19
constexpr uint32_t OAS_32 = 0
constexpr uint32_t OAS_36 = 1
constexpr uint32_t OAS_40 = 2
constexpr uint32_t OAS_42 = 3
constexpr uint32_t OAS_44 = 4
constexpr uint32_t OAS_48 = 5
constexpr uint32_t PA_BITS = 48
constexpr uint32_t VA_SIGN_BIT_SHIFT = 63
constexpr uint32_t IPA_PAGE_SHIFT = 12
constexpr uint32_t INPUT_SIZE_MIN = 25
constexpr uint32_t INPUT_SIZE_MAX = 48
constexpr std::array< uint32_t, 8 > OUTPUT_SIZE_MAP = { 32, 36, 40, 42, 44, 48, 48, 48 }
constexpr std::array< uint32_t, 12 > PRIMECELL_IDS

Detailed Description

Tool which reads a Lua configuration file and sets parameters.

Bi-directional Flow controlled socket.

Helper macro to register an sc_module constructor, complete with its (typed) arguments.

Lua Config File Tool which reads a configuration file and uses the Tool_GCnf_Api to set the parameters during intitialize-mode.

One instance can be used to read and configure several lua config files.

The usage of this Tool:

  • instantiate one object
  • call config(filename)

The bi-directional flow controlled socket is intended to be used between devices and serial-like back-ends.

The socket transports 'standard' Generic Protocol TLM packets, but ONLY makes use of the data component. The socket is templated on a type (T) which is the unit of data that will be transmitted. (Default is uint8)

The interface allows the socket owner to allow a specific, or unlimited amount of data to arrive. Hence the owner may specify that only one item can arrive (hence use a send/acknowledge protocol), or it may use a limited buffer protocol (typical of a uart for instance) or, for instance, for an output to a host, which itself is normally buffered, the socket may be set to receive unlimited data.

**** NOTICE : async_detach_suspending / async_attach_suspending ****

The bidirectional socket will own an async_event, 'waiting' for the other side of the communication.

  • In the case of ZERO, or UNLIMITED data, the expectation is that the async_event should NOT cause systemC to wait for external events
  • In the case of an absolute value above 0, the expectation is that SystemC SHOULD wait for external events.

NOTE: Hence, all sockets start DETACHED, and will only be attached if/when a non-zero absolute value is received from the other side.

Function Documentation

◆ container_of()

template<class PARENT_TYPE, class MEMBER_TYPE>
PARENT_TYPE * gs::container_of ( const MEMBER_TYPE * member,
const MEMBER_TYPE PARENT_TYPE::* member_ptr )

Get the pointer of PARENT_TYPE instance containing the MEMBER_TYPE member using a pointer to this member. Args: member: pointer of type MEMBER_TYPE* to the member. member_ptr: pointer of type PARENT_TYPE::* to the specific member of the PARENT_TYPE. Ret: pointer to the parent instance of type PARENT_TYPE contaning the member pointer.

◆ dtb_build()

std::vector< uint8_t > gs::dtb_build ( const std::string & base,
const std::vector< std::string > & overlays,
std::string & error )

Build a flattened device tree from a base DTB and ordered overlays.

Reads base, applies each overlay in overlays in order (libfdt fdt_overlay_apply, i.e. the same operation as fdtoverlay), packs the result and validates it with fdt_check_full.

The base DTB must have been compiled with symbols (dtc -@) when the overlays reference labels, and the overlays must be compiled as plugins.

Parameters
basePath to the base DTB.
overlaysPaths to DTBO files, applied in order.
errorSet to a human readable message on failure.
Returns
The final DTB, or an empty vector on failure.

◆ find_sc_obj()

sc_core::sc_object * gs::find_sc_obj ( sc_core::sc_object * m,
std::string name,
bool test = false )

Helper function to find a sc_object by fully qualified name throws SC_ERROR if nothing found.

Parameters
mcurrent parent object (use null to start from the top)
namename being searched for
Returns
sc_core::sc_object* return object if found

◆ find_sc_objects()

template<typename T>
std::vector< T * > gs::find_sc_objects ( sc_core::sc_object * m = nullptr)

Helper function to find a sc_objects of a given type.

Parameters
mcurrent parent object (use null to start from the top)
Template Parameters
Ttypename being searched for
Returns
std::vector<sc_core::sc_object*> list of sc_objects found

◆ sc_cci_children()

std::list< std::string > gs::sc_cci_children ( sc_core::sc_module_name name)

return a list of 'unconsumed' children from the given module name, can be used inside or outside the heirarchy

Parameters
name
Returns
std::list<std::string>

◆ sc_cci_leaf_name()

std::string gs::sc_cci_leaf_name ( std::string name)

return the leaf name of the given systemc hierarchical name

Parameters
name
Returns
std::string

◆ sc_cci_list_items()

std::list< std::string > gs::sc_cci_list_items ( sc_core::sc_module_name module_name,
std::string list_name )

return a list of 'unconsumed' items in the module matching the base name given, plus '_' and a numeric value typically this would be a list of items from an sc_vector Can be used inside or outside the heirarchy

Parameters
module_name: name of the module
list_name: base name of the list (e.g. name of the sc_vector)
Returns
std::list<std::string>

◆ SC_MODULE()

gs::SC_MODULE ( realtimelimiter )

realtimelimiter: sc_module which suspends SystemC if SystemC time drifts ahead of realtime

Parameters

RTquantum_ms : realtime tick rate between checks.

Parameters

SCTimeout_ms : If SystemC time is behind by more than this value, then generate a fatal abort (0 disables)

◆ sc_thread_try_wait()

bool gs::sc_thread_try_wait ( pybind11::object obj,
py_wait_type type )

FIXME: This is a work around to mitigate a problem happening in python implemented systemc thread functions, now pybind11 will fail to switch from a python function context after a systemc sc_core::wait() call and generates this exception: "loader_life_support: internal error", the current solution assumes that python systemc thread function which includes a sc_core::wait() call is implemented as a generator and yield is used instead of sc_core::wait(), and each time the python systemc thread function yields, a check for the yield value is done to execute the appropriate sc_core::next_trigger() function. So, the actual systemc thread context switch will be replaced with multiple systemc methods.

◆ zip_extract()

std::vector< uint8_t > gs::zip_extract ( zip_t * archive,
const std::string & archive_name,
const std::string & file_name = "",
uint64_t file_offset = 0,
uint64_t file_data_len = 0 )

Extract data from a zip archive.

Parameters
archiveLive zip handle (may be nullptr; if nullptr, archive_name is opened from disk).
archive_namePath to the zip archive file (used when archive is nullptr, and in messages).
file_nameName of the file within the archive (empty = first entry).
file_offsetOffset within the extracted file data.
file_data_lenLength to extract (0 = entire file).
Returns
Extracted data as a byte vector.

◆ zip_extract_nested()

std::vector< uint8_t > gs::zip_extract_nested ( zip_t * archive,
const std::string & archive_name,
const std::string & compressed_file_name,
const std::string & inner_file_name,
uint64_t file_offset = 0,
uint64_t file_data_len = 0 )

Extract compressed data from a nested zip archive.

Extracts a compressed file from the outer archive, then extracts data from the inner archive.

Parameters
archiveLive zip handle for the outer archive (may be nullptr; if nullptr, archive_name is opened from disk).
archive_namePath to the outer zip archive (used when archive is nullptr, and in messages).
compressed_file_nameName of the compressed file in the outer archive.
inner_file_nameName of the file in the inner archive.
file_offsetOffset within the extracted data.
file_data_lenLength to extract (0 = entire file).
Returns
Extracted data as a byte vector.

Variable Documentation

◆ PRIMECELL_IDS

std::array<uint32_t, 12> gs::PRIMECELL_IDS
constexpr
Initial value:
= {
0x04, 0x00, 0x00, 0x00, 0x34, 0xB0, 0x0B, 0x00, 0x0D, 0xF0, 0x05, 0xB1,
}