PebbleOS v4.47.0-160-g9e782207f
Loading...
Searching...
No Matches
pbl_ram_ops Struct Reference

Driver operations. More...

#include <ram.h>

Data Fields

int(* init )(const struct pbl_ram *ram)
 Bring the memory up, powered off, and set where it is mapped and its size in the state.
 
int(* power_on )(const struct pbl_ram *ram)
 Power the memory on.
 
void(* power_off )(const struct pbl_ram *ram)
 Power the memory off, losing its contents.
 
void(* retain )(const struct pbl_ram *ram)
 Optional.
 
void(* resume )(const struct pbl_ram *ram)
 With retain.
 
void(* quiesce )(const struct pbl_ram *ram)
 Optional.
 

Detailed Description

Driver operations.

Field Documentation

◆ init

int(* pbl_ram_ops::init) (const struct pbl_ram *ram)

Bring the memory up, powered off, and set where it is mapped and its size in the state.

Returns 0 or a negative errno.

◆ power_off

void(* pbl_ram_ops::power_off) (const struct pbl_ram *ram)

Power the memory off, losing its contents.

Runs with interrupts disabled.

◆ power_on

int(* pbl_ram_ops::power_on) (const struct pbl_ram *ram)

Power the memory on.

Returns 0 or a negative errno.

◆ quiesce

void(* pbl_ram_ops::quiesce) (const struct pbl_ram *ram)

Optional.

Wait until the memory has taken everything written to it. Runs before the CPU stops its clocks, with interrupts disabled.

◆ resume

void(* pbl_ram_ops::resume) (const struct pbl_ram *ram)

With retain.

Leave that state. Runs in deep sleep exit, with interrupts disabled.

◆ retain

void(* pbl_ram_ops::retain) (const struct pbl_ram *ram)

Optional.

Put the memory in a state that keeps its contents with less power. Runs in deep sleep entry, with interrupts disabled.


The documentation for this struct was generated from the following file: