mirror of
https://github.com/google/pebble.git
synced 2025-05-05 01:11:40 -04:00
57 lines
2.4 KiB
C
57 lines
2.4 KiB
C
/*
|
|
* Copyright 2024 Google LLC
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "flash_region/flash_region.h"
|
|
#include "kernel/events.h"
|
|
|
|
#include <stddef.h>
|
|
|
|
#define SHELL_PREFS_FILE_NAME "shellpref"
|
|
// TODO: PBL-42170 Improve settings file to better utilize large sector sizes
|
|
// We want to use a full page, but requesting such a size can end up using two pages
|
|
#define SHELL_PREFS_FILE_LEN (2048)
|
|
|
|
|
|
//! Update the backing store for the given preference.
|
|
//! @param[in] key the preference's name, as defined in prefs.c
|
|
//! @param[in] key_len the length of key
|
|
//! @param[in] value pointer to the new value
|
|
//! @param[in] length of the value
|
|
//! @return true on success, false if failure
|
|
bool prefs_private_write_backing(const uint8_t *key, size_t key_len, const void *value,
|
|
int value_len);
|
|
|
|
//! Get the length of a preference's value as stored in the backing store
|
|
//! @param[in] key the preference's name, as defined in prefs.c
|
|
//! @param[in] key_len the length of key
|
|
//! @return the >0 length upon success, or 0 if the preference was not found
|
|
int prefs_private_get_backing_len(const uint8_t *key, size_t key_len);
|
|
|
|
//! Read the value of a preference from the backing store.
|
|
//! @param[in] key the preference's name, as defined in prefs.c
|
|
//! @param[in] key_len the length of key
|
|
//! @param[out] value the value will be written into this pointer
|
|
//! @param[in] length of the value
|
|
//! @return true on success, false if failure
|
|
bool prefs_private_read_backing(const uint8_t *key, size_t key_len, void *value, int value_len);
|
|
|
|
//! Process a blobDB event issued for the prefs DB (BlobDBIdPrefs). For BlobDBEventTypeInsert
|
|
//! events, this method will update the internal global copy of that preference based on the
|
|
//! new value that was placed into the backing store.
|
|
//! @param[in] event pointer to the blob DB event
|
|
void prefs_private_handle_blob_db_event(PebbleBlobDBEvent *event);
|