PRU User Space API  v1.0.0
An API to control the BeagleBone PRUs using the RemoteProc and RPMsg framework.
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
PRUSS Class Reference

class PRUSS More...

#include <pruss.h>

Collaboration diagram for PRUSS:
Collaboration graph
[legend]

Public Member Functions

bool isOn ()
 Check if the PRU-ICSS has booted up. More...
 
int bootUp ()
 Boot Up the PRU-ICSS. More...
 
int shutDown ()
 Shut Down the PRU-ICSS. More...
 
void restart ()
 Restart the PRU-ICSS system. More...
 

Static Public Member Functions

static PRUSSget ()
 Function that returns an object of type PRUSS to the user. More...
 

Public Attributes

PRU pru0
 
PRU pru1
 

Detailed Description

class PRUSS

Member Function Documentation

◆ bootUp()

int PRUSS::bootUp ( )

Boot Up the PRU-ICSS.

Probe the pru_rproc remoteproc driver so that all the sysfs entries for controlling the PRUs are created. Sets the 'state' of the PRU to STOPPED after successfully probing the driver

Returns
0 if pru_rproc is probed successfully

◆ get()

PRUSS & PRUSS::get ( )
static

Function that returns an object of type PRUSS to the user.

Returns
object of type PRUSS

◆ isOn()

bool PRUSS::isOn ( )

Check if the PRU-ICSS has booted up.

Returns
boolean value true if the pru_rproc driver has been probed

◆ restart()

void PRUSS::restart ( )

Restart the PRU-ICSS system.

Shuts down and restarts the PRU-ICSS

See also
shutDown()
bootUp()

◆ shutDown()

int PRUSS::shutDown ( )

Shut Down the PRU-ICSS.

Stops both the PRUs and unprobes the pru_rproc remoteproc driver from the kernel Sets the 'state' of both PRUs to NONE after successfully doing so

Returns
0 if pru_rproc is unprobed successfully

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