File ns_peripherals_psram.h

FileList > includes-api > ns_peripherals_psram.h

Go to the source code of this file

Enable PSRAM. More...

• #include "ns_core.h"

Classes

Type	Name
struct	ns_psram_config_t

Public Types

Type	Name
enum	psram_type_e

Public Attributes

Type	Name
const ns_core_api_t	ns_psram_V0_0_1
const ns_core_api_t	ns_psram_current_version
const ns_core_api_t	ns_psram_oldest_supported_version

Public Functions

Type	Name
uint32_t	ns_psram_init (ns_psram_config_t * cfg) Initialize PSRAM per the configuration struct.

Macros

Type	Name
define	NS_PSRAM_API_ID 0xCA000A
define	NS_PSRAM_CURRENT_VERSION NS\_PSRAM\_V1\_0\_0
define	NS_PSRAM_OLDEST_SUPPORTED_VERSION NS\_PSRAM\_V0\_0\_1
define	NS_PSRAM_V0_0_1 { .major = 0, .minor = 0, .revision = 1 }
define	NS_PSRAM_V1_0_0 { .major = 1, .minor = 0, .revision = 0 }

Detailed Description

Author:

Ambiq

Version:

0.1

Date:

2024-04-19

Copyright:

Copyright (c) 2024

Public Types Documentation

enum psram_type_e

enum psram_type_e {
    PSRAM_TYPE_HEX = 0,
    PSRAM_TYPE_OCT = 1
};

---

Public Attributes Documentation

variable ns_psram_V0_0_1

const ns_core_api_t ns_psram_V0_0_1;

---

variable ns_psram_current_version

const ns_core_api_t ns_psram_current_version;

---

variable ns_psram_oldest_supported_version

const ns_core_api_t ns_psram_oldest_supported_version;

---

Public Functions Documentation

function ns_psram_init

Initialize PSRAM per the configuration struct.

uint32_t ns_psram_init (
    ns_psram_config_t * cfg
) 

Parameters:

• ns_psram_config_t* : psram configuration struct

Returns:

uint32_t

---

Macro Definition Documentation

define NS_PSRAM_API_ID

#define NS_PSRAM_API_ID `0xCA000A`

---

define NS_PSRAM_CURRENT_VERSION

#define NS_PSRAM_CURRENT_VERSION `NS_PSRAM_V1_0_0`

---

define NS_PSRAM_OLDEST_SUPPORTED_VERSION

#define NS_PSRAM_OLDEST_SUPPORTED_VERSION `NS_PSRAM_V0_0_1`

---

define NS_PSRAM_V0_0_1

#define NS_PSRAM_V0_0_1 `{ .major = 0, .minor = 0, .revision = 1 }`

---

define NS_PSRAM_V1_0_0

#define NS_PSRAM_V1_0_0 `{ .major = 1, .minor = 0, .revision = 0 }`

---

---

The documentation for this class was generated from the following file neuralSPOT/neuralspot/ns-peripherals/includes-api/ns_peripherals_psram.h