This is an automated email from the ASF dual-hosted git repository.
jerzy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mynewt-core.git
The following commit(s) were added to refs/heads/master by this push:
new 7278095a9 sys/log: Add simple fcb log
7278095a9 is described below
commit 7278095a9c14ba5034f6c06f20c26762c225ca21
Author: Jerzy Kasenberg <[email protected]>
AuthorDate: Tue Mar 25 12:39:04 2025 +0100
sys/log: Add simple fcb log
Package adds functionality to register FCB or FCB2 based log
for given flash area.
Package by default adds one instance of a log, parametrized in
syscfg.
User code can disable default instance and create several
logs for different purposes with simple_fcb_log_registers()
function.
Basic usage of this package is to provide flash area id i.e.:
syscfg.vals:
SIMPLE_FCB_LOG_0_FLASH_AREA: FLASH_AREA_NFFS
Signed-off-by: Jerzy Kasenberg <[email protected]>
---
.../include/simple_fcb_log/simple_fcb_log.h | 67 +++++++++
sys/log/simple_fcb_log/pkg.yml | 34 +++++
sys/log/simple_fcb_log/src/simple_fcb_log.c | 162 +++++++++++++++++++++
sys/log/simple_fcb_log/syscfg.yml | 70 +++++++++
4 files changed, 333 insertions(+)
diff --git a/sys/log/simple_fcb_log/include/simple_fcb_log/simple_fcb_log.h
b/sys/log/simple_fcb_log/include/simple_fcb_log/simple_fcb_log.h
new file mode 100644
index 000000000..965076560
--- /dev/null
+++ b/sys/log/simple_fcb_log/include/simple_fcb_log/simple_fcb_log.h
@@ -0,0 +1,67 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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.
+ */
+
+#ifndef H_SIMPLE_FCB_LOG_
+#define H_SIMPLE_FCB_LOG_
+
+#include <os/mynewt.h>
+#include <log/log.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#if MYNEWT_VAL(LOG_FCB)
+struct simple_fcb_log {
+ struct log log;
+ struct fcb_log fcb_log;
+ /** Number of sectors in sectors array */
+ uint32_t sector_count;
+ /** Sectors used by FCB */
+ struct flash_area *sectors;
+};
+
+#elif MYNEWT_VAL(LOG_FCB2)
+
+struct simple_fcb_log {
+ struct log log;
+ struct fcb_log fcb_log;
+ struct flash_sector_range sectors;
+};
+
+#endif
+
+/**
+ * Initialize and add simple FCB or FCB2 based log
+ *
+ * @param simplelog - simple log to initialize and register
+ * @param flash_area_id - flash area to be used for storage
+ * @param log_name - log name
+ * @param fcb_magic - value that is stored in every sector to allow
verification that
+ * sector belongs to fcb log
+ * @return 0 on success, non-zero on failure
+ */
+int simple_fcb_log_register(struct simple_fcb_log *simplelog, int
flash_area_id,
+ const char *log_name, uint32_t fcb_magic);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif
diff --git a/sys/log/simple_fcb_log/pkg.yml b/sys/log/simple_fcb_log/pkg.yml
new file mode 100644
index 000000000..d3324dd5b
--- /dev/null
+++ b/sys/log/simple_fcb_log/pkg.yml
@@ -0,0 +1,34 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you 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.
+#
+
+pkg.name: sys/log/simple_fcb_log
+pkg.description: Implementation of fcb or fcb2 log assigned to flash area.
+pkg.author: "Apache Mynewt <[email protected]>"
+pkg.homepage: "http://mynewt.apache.org/";
+pkg.keywords:
+ - logging
+
+pkg.deps:
+ - "@apache-mynewt-core/sys/log"
+
+pkg.req_apis:
+ - log
+
+pkg.init.SIMPLE_FCB_LOG_0:
+ simple_fcb_log_0_init: $after:log_init
diff --git a/sys/log/simple_fcb_log/src/simple_fcb_log.c
b/sys/log/simple_fcb_log/src/simple_fcb_log.c
new file mode 100644
index 000000000..8117f7f21
--- /dev/null
+++ b/sys/log/simple_fcb_log/src/simple_fcb_log.c
@@ -0,0 +1,162 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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.
+ */
+
+#include <os/mynewt.h>
+#include <log/log.h>
+#include <fcb/fcb.h>
+#include <simple_fcb_log/simple_fcb_log.h>
+
+#if MYNEWT_VAL(LOG_FCB)
+int
+simple_fcb_log_register(struct simple_fcb_log *simplelog, int flash_area_id,
const char *log_name,
+ uint32_t fcb_magic)
+{
+ const struct flash_area *fa;
+ struct fcb *fcbp;
+ int sector_count;
+ int rc;
+
+ assert(simplelog != NULL);
+
+ fcbp = &simplelog->fcb_log.fl_fcb;
+
+ if (flash_area_open(flash_area_id, &fa)) {
+ return SYS_EUNKNOWN;
+ }
+
+ flash_area_to_sectors(flash_area_id, §or_count, NULL);
+
+ if (simplelog->sector_count == 0) {
+ simplelog->sectors = calloc(sector_count, sizeof(*simplelog->sectors));
+ if (simplelog->sectors) {
+ simplelog->sector_count = sector_count;
+ }
+ }
+
+ if (simplelog->sectors == 0) {
+ rc = SYS_ENOMEM;
+ } else {
+ flash_area_to_sectors(flash_area_id, §or_count,
simplelog->sectors);
+ simplelog->fcb_log.fl_entries = 0;
+ fcbp->f_magic = fcb_magic;
+ fcbp->f_version = g_log_info.li_version;
+ fcbp->f_sector_cnt = sector_count;
+ fcbp->f_scratch_cnt = 0;
+ fcbp->f_sectors = simplelog->sectors;
+
+ rc = fcb_init(fcbp);
+ if (rc) {
+ flash_area_erase(fa, 0, fa->fa_size);
+ rc = fcb_init(fcbp);
+ if (rc) {
+ return rc;
+ }
+ }
+
+ rc = log_register(log_name, &simplelog->log, &log_fcb_handler,
+ &simplelog->fcb_log, LOG_SYSLEVEL);
+ }
+ return rc;
+}
+
+#else
+
+int
+simple_fcb_log_register(struct simple_fcb_log *simplelog, int flash_area_id,
const char *log_name,
+ uint32_t fcb_magic)
+{
+ const struct flash_area *fa;
+ struct fcb2 *fcbp;
+ int range_count = 1;
+ int rc;
+
+ assert(simplelog != NULL);
+
+ fcbp = &simplelog->fcb_log.fl_fcb;
+
+ if (flash_area_open(flash_area_id, &fa)) {
+ return SYS_EUNKNOWN;
+ }
+
+ flash_area_to_sector_ranges(flash_area_id, &range_count,
&simplelog->sectors);
+
+ fcbp->f_magic = fcb_magic;
+ fcbp->f_version = g_log_info.li_version;
+ fcbp->f_sector_cnt = simplelog->sectors.fsr_sector_count;
+ fcbp->f_range_cnt = 1;
+ fcbp->f_ranges = &simplelog->sectors;
+
+ rc = fcb2_init(fcbp);
+ if (rc) {
+ flash_area_erase(fa, 0, fa->fa_size);
+ rc = fcb2_init(fcbp);
+ if (rc) {
+ return rc;
+ }
+ }
+
+ rc = log_register(log_name, &simplelog->log, &log_fcb_handler,
+ &simplelog->fcb_log, LOG_SYSLEVEL);
+
+ return rc;
+}
+
+#endif
+
+#if MYNEWT_VAL(SIMPLE_FCB_LOG_0)
+static struct simple_fcb_log simple_fcb_log_0;
+
+#if MYNEWT_VAL(SIMPLE_FCB_LOG_0_BOOKMARKS)
+#if MYNEWT_VAL(SIMPLE_FCB_LOG_0_BOOKMARK_COUNT)
+/* Bookmark count is provided in syscfg */
+static struct log_fcb_bmark
simple_fcb_log_0_bookmarks[MYNEWT_VAL(SIMPLE_FCB_LOG_0_BOOKMARK_COUNT)];
+#elif MYNEWT_VAL(LOG_FCB_SECTOR_BOOKMARKS) == 0
+/* Sector bookmarks are not enabled, reserve space based on
LOG_FCB_NUM_ABS_BOOKMARKS */
+static struct log_fcb_bmark
simple_fcb_log_0_bookmarks[MYNEWT_VAL(LOG_FCB_NUM_ABS_BOOKMARKS)];
+#else
+/*
+ * Bookmarks are enabled including sector bookmarks but size is not set,
+ * bookmarks array will be placed on heap.
+ */
+static struct log_fcb_bmark *simple_fcb_log_0_bookmarks;
+#endif
+#endif
+
+void
+simple_fcb_log_0_init(void)
+{
+ simple_fcb_log_register(&simple_fcb_log_0,
MYNEWT_VAL(SIMPLE_FCB_LOG_0_FLASH_AREA),
+ MYNEWT_VAL(SIMPLE_FCB_LOG_0_NAME),
MYNEWT_VAL(SIMPLE_FCB_LOG_0_FCB_MAGIC));
+
+#if MYNEWT_VAL(SIMPLE_FCB_LOG_0_BOOKMARKS)
+ int bookmark_count;
+
+#if MYNEWT_VAL(SIMPLE_FCB_LOG_0_BOOKMARK_COUNT) ||
MYNEWT_VAL(LOG_FCB_SECTOR_BOOKMARKS) == 0
+ bookmark_count = ARRAY_SIZE(simple_fcb_log_0_bookmarks);
+#else
+ bookmark_count = (simple_fcb_log_0.sector_count +
MYNEWT_VAL(LOG_FCB_NUM_ABS_BOOKMARKS));
+ simple_fcb_log_0_bookmarks = malloc(bookmark_count *
sizeof(simple_fcb_log_0_bookmarks[0]));
+#endif
+ if (simple_fcb_log_0_bookmarks != NULL) {
+ log_fcb_init_bmarks(&simple_fcb_log_0.fcb_log,
simple_fcb_log_0_bookmarks, bookmark_count,
+ bookmark_count >
MYNEWT_VAL(LOG_FCB_NUM_ABS_BOOKMARKS));
+ }
+#endif
+}
+#endif
diff --git a/sys/log/simple_fcb_log/syscfg.yml
b/sys/log/simple_fcb_log/syscfg.yml
new file mode 100644
index 000000000..5516e5986
--- /dev/null
+++ b/sys/log/simple_fcb_log/syscfg.yml
@@ -0,0 +1,70 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you 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.
+#
+
+syscfg.defs:
+ SIMPLE_FCB_LOG_0:
+ description: >
+ Create and initialize instance of simple log.
+ When set to 0 default instance of simple log is not created,
+ user code can call simple_fcb_log_init() function to initialize
+ instance(es) of logs.
+ value: 1
+
+syscfg.defs.SIMPLE_FCB_LOG_0:
+ SIMPLE_FCB_LOG_0_FLASH_AREA:
+ description: >
+ Flash area for simple log instance.
+ value:
+ restrictions:
+ - $notnull
+
+ SIMPLE_FCB_LOG_0_NAME:
+ description: >
+ Simple log name.
+ value: '"simplelog"'
+
+ SIMPLE_FCB_LOG_0_FCB_MAGIC:
+ description: >
+ Magic number that identifies flash area structure to be FCB.
+ value:
+
+ SIMPLE_FCB_LOG_0_BOOKMARKS:
+ description: >
+ Enable bookmarks for simple log.
+ value: 0
+ restrictions:
+ - 'LOG_FCB_BOOKMARKS if 1'
+
+ SIMPLE_FCB_LOG_0_BOOKMARK_COUNT:
+ description: >
+ Maximum number of bookmarks. When this value is 0 and
SIMPLE_FCB_LOG_0_BOOKMARKS
+ is enabled and LOG_FCB_SECTOR_BOOKMARKS is enabled, bookmarks are
allocated
+ on heap and number of bookmarks is sum of flash area sector count
and LOG_FCB_NUM_ABS_BOOKMARKS.
+ value: 0
+
+ SIMPLE_FCB_LOG_0_SYSINIT_STAGE:
+ description: >
+ Sysinit stage for instance if simple log.
+ value: 100
+
+syscfg.vals.LOG_FCB:
+ SIMPLE_FCB_LOG_0_FCB_MAGIC: 0x31474F4C
+
+syscfg.vals.LOG_FCB2:
+ SIMPLE_FCB_LOG_0_FCB_MAGIC: 0x32474F4C
