geopm::SSTIoctl Class Reference

Defines functions that interact directly with SST ioctls. More...

#include <SSTIoctl.hpp>

Inheritance diagram for geopm::SSTIoctl:

Public Member Functions
virtual	~SSTIoctl ()=default
virtual int	version (sst_version_s *version)=0
	Send an ioctl to the SST version interface.
virtual int	get_cpu_id (sst_cpu_map_interface_batch_s *cpu_batch)=0
	Get mappings of logical CPUs to punit CPUs.
virtual int	mbox (sst_mbox_interface_batch_s *mbox_batch)=0
	Interact with the SST mailbox. This may be for send or receive operations.
virtual int	mmio (sst_mmio_interface_batch_s *mmio_batch)=0
	Interact with the SST MMIO interface. This may be for read or write operations.

Static Public Member Functions
static std::shared_ptr< SSTIoctl >	make_shared (const std::string &path)
	create an object to interact with this interface.

Detailed Description

Defines functions that interact directly with SST ioctls.

Constructor & Destructor Documentation

~SSTIoctl()

virtual geopm::SSTIoctl::~SSTIoctl ( )

virtualdefault

Member Function Documentation

get_cpu_id()

virtual int geopm::SSTIoctl::get_cpu_id ( sst_cpu_map_interface_batch_s *  cpu_batch )

pure virtual

Get mappings of logical CPUs to punit CPUs.

Parameters

[in,out]

cpu_batch

a set of CPU mappings. The maximum number of mappings per ioctl request is specified by the SST version information.

Implemented in geopm::SSTIoctlImp.

make_shared()

std::shared_ptr< SSTIoctl > geopm::SSTIoctl::make_shared ( const std::string &  path )

static

create an object to interact with this interface.

Parameters

path	Path to the ioctl node.

mbox()

virtual int geopm::SSTIoctl::mbox ( sst_mbox_interface_batch_s *  mbox_batch )

pure virtual

Interact with the SST mailbox. This may be for send or receive operations.

Parameters

[in,out]

mbox_batch

collection of operations to perform in this ioctl call. The maximum count of operations is specified by the SST version information.

Implemented in geopm::SSTIoctlImp.

mmio()

virtual int geopm::SSTIoctl::mmio ( sst_mmio_interface_batch_s *  mmio_batch )

pure virtual

Interact with the SST MMIO interface. This may be for read or write operations.

Parameters

[in,out]

mmio_batch

collection of operations to perform in this ioctl call. The maximum count of operations is specified by the SST version information.

Implemented in geopm::SSTIoctlImp.

version()

virtual int geopm::SSTIoctl::version ( sst_version_s *  version )

pure virtual

Send an ioctl to the SST version interface.

Parameters

[out]

version

SST version information.

Implemented in geopm::SSTIoctlImp.

---

The documentation for this class was generated from the following files:

• SSTIoctl.hpp
• SSTIoctl.cpp