geopm  3.1.1.dev272+gdfb40a8d
GEOPM - Global Extensible Open Power Manager
Public Member Functions | List of all members
geopm::SSTIoctlImp Class Referencefinal

#include <SSTIoctlImp.hpp>

Inheritance diagram for geopm::SSTIoctlImp:
Inheritance graph
[legend]
Collaboration diagram for geopm::SSTIoctlImp:
Collaboration graph
[legend]

Public Member Functions

 SSTIoctlImp (const std::string &path)
 create an object to interact with this interface. More...
 
 SSTIoctlImp (const SSTIoctlImp &other)=delete
 
SSTIoctlImpoperator= (const SSTIoctlImp &other)=delete
 
 ~SSTIoctlImp ()
 
int version (sst_version_s *version) override
 Send an ioctl to the SST version interface. More...
 
int get_cpu_id (sst_cpu_map_interface_batch_s *cpu_batch) override
 Get mappings of logical CPUs to punit CPUs. More...
 
int mbox (sst_mbox_interface_batch_s *mbox_batch) override
 Interact with the SST mailbox. This may be for send or receive operations. More...
 
int mmio (sst_mmio_interface_batch_s *mmio_batch) override
 Interact with the SST MMIO interface. This may be for read or write operations. More...
 
- Public Member Functions inherited from geopm::SSTIoctl
virtual ~SSTIoctl ()=default
 

Additional Inherited Members

- Static Public Member Functions inherited from geopm::SSTIoctl
static std::shared_ptr< SSTIoctlmake_shared (const std::string &path)
 create an object to interact with this interface. More...
 

Constructor & Destructor Documentation

◆ SSTIoctlImp() [1/2]

geopm::SSTIoctlImp::SSTIoctlImp ( const std::string &  path)

create an object to interact with this interface.

Parameters
pathPath to the ioctl node.

◆ SSTIoctlImp() [2/2]

geopm::SSTIoctlImp::SSTIoctlImp ( const SSTIoctlImp other)
delete

◆ ~SSTIoctlImp()

geopm::SSTIoctlImp::~SSTIoctlImp ( )

Member Function Documentation

◆ get_cpu_id()

int geopm::SSTIoctlImp::get_cpu_id ( sst_cpu_map_interface_batch_s cpu_batch)
overridevirtual

Get mappings of logical CPUs to punit CPUs.

Parameters
[in,out]cpu_batcha set of CPU mappings. The maximum number of mappings per ioctl request is specified by the SST version information.

Implements geopm::SSTIoctl.

◆ mbox()

int geopm::SSTIoctlImp::mbox ( sst_mbox_interface_batch_s mbox_batch)
overridevirtual

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

Parameters
[in,out]mbox_batchcollection of operations to perform in this ioctl call. The maximum count of operations is specified by the SST version information.

Implements geopm::SSTIoctl.

◆ mmio()

int geopm::SSTIoctlImp::mmio ( sst_mmio_interface_batch_s mmio_batch)
overridevirtual

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

Parameters
[in,out]mmio_batchcollection of operations to perform in this ioctl call. The maximum count of operations is specified by the SST version information.

Implements geopm::SSTIoctl.

◆ operator=()

SSTIoctlImp& geopm::SSTIoctlImp::operator= ( const SSTIoctlImp other)
delete

◆ version()

int geopm::SSTIoctlImp::version ( sst_version_s version)
overridevirtual

Send an ioctl to the SST version interface.

Parameters
[out]versionSST version information.

Implements geopm::SSTIoctl.


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