1c2b93d6bSLee Trager /* SPDX-License-Identifier: GPL-2.0 */ 2c2b93d6bSLee Trager /* Copyright (c) Meta Platforms, Inc. and affiliates. */ 3c2b93d6bSLee Trager 4c2b93d6bSLee Trager #ifndef _FBNIC_FW_LOG_H_ 5c2b93d6bSLee Trager #define _FBNIC_FW_LOG_H_ 6c2b93d6bSLee Trager 7c2b93d6bSLee Trager #include <linux/spinlock.h> 8c2b93d6bSLee Trager #include <linux/types.h> 9c2b93d6bSLee Trager 10c2b93d6bSLee Trager /* A 512K log buffer was chosen fairly arbitrarily */ 11c2b93d6bSLee Trager #define FBNIC_FW_LOG_SIZE (512 * 1024) /* bytes */ 12c2b93d6bSLee Trager 13c2b93d6bSLee Trager /* Firmware log output is prepended with log index followed by a timestamp. 14c2b93d6bSLee Trager * The timestamp is similar to Zephyr's format DD:HH:MM:SS.MMM 15c2b93d6bSLee Trager */ 16c2b93d6bSLee Trager #define FBNIC_FW_LOG_FMT "[%5lld] [%02ld:%02ld:%02ld:%02ld.%03ld] %s\n" 17c2b93d6bSLee Trager 18c2b93d6bSLee Trager struct fbnic_dev; 19c2b93d6bSLee Trager 20c2b93d6bSLee Trager struct fbnic_fw_log_entry { 21c2b93d6bSLee Trager struct list_head list; 22c2b93d6bSLee Trager u64 index; 23c2b93d6bSLee Trager u32 timestamp; 24c2b93d6bSLee Trager u16 len; 25c2b93d6bSLee Trager char msg[] __counted_by(len); 26c2b93d6bSLee Trager }; 27c2b93d6bSLee Trager 28c2b93d6bSLee Trager struct fbnic_fw_log { 29c2b93d6bSLee Trager void *data_start; 30c2b93d6bSLee Trager void *data_end; 31c2b93d6bSLee Trager size_t size; 32c2b93d6bSLee Trager struct list_head entries; 33c2b93d6bSLee Trager /* Spin lock for accessing or modifying entries */ 34c2b93d6bSLee Trager spinlock_t lock; 35c2b93d6bSLee Trager }; 36c2b93d6bSLee Trager 37c2b93d6bSLee Trager #define fbnic_fw_log_ready(_fbd) (!!(_fbd)->fw_log.data_start) 38c2b93d6bSLee Trager 39*ecc53b1bSLee Trager void fbnic_fw_log_enable(struct fbnic_dev *fbd, bool send_hist); 40*ecc53b1bSLee Trager void fbnic_fw_log_disable(struct fbnic_dev *fbd); 41c2b93d6bSLee Trager int fbnic_fw_log_init(struct fbnic_dev *fbd); 42c2b93d6bSLee Trager void fbnic_fw_log_free(struct fbnic_dev *fbd); 43c2b93d6bSLee Trager int fbnic_fw_log_write(struct fbnic_dev *fbd, u64 index, u32 timestamp, 44c2b93d6bSLee Trager char *msg); 45c2b93d6bSLee Trager #endif /* _FBNIC_FW_LOG_H_ */ 46