storage_creds_decls.h

Go to the documentation of this file.

/* Declaration surface for the storage_creds docs-only reference set.
 *
 * storage_creds has no dist include directory, and a \fn block is fatal
 * under WARN_AS_ERROR unless a declaration exists for it to attach to. The
 * six prototypes below are copied verbatim from
 * dist/mpy_secure/include/lfs_wifi_creds.h, the header both variants ship,
 * AND so are their doc comments — the mtb-only run reads this file instead
 * of that header, so without the comments here the mtb-only site's
 * lfs_wifi_creds reference page loses every brief/detailed description
 * (RED2 F-4). Keep both in lockstep with the real header. The additional
 * contract documentation lives in lfs_wifi_creds.dox. This file is read
 * only by doxygen, and only by the mtb-only run — the mtb-mpy run EXCLUDEs
 * it because dist/mpy_secure/include/lfs_wifi_creds.h is already in its
 * INPUT and the six functions must not be declared twice (bento-release.sh
 * cmd_docs_html dedupe). Never compiled, never shipped as an include.
 */
#pragma once

void lfs_wifi_creds_init(void);

void lfs_wifi_creds_deinit(void);

bool lfs_wifi_creds_ready(void);

int lfs_wifi_creds_read(qspi_wifi_entry_t *entries, int max_entries);

bool lfs_wifi_creds_write(const qspi_wifi_entry_t *entries, int count);

bool lfs_wifi_creds_needs_resave(void);