mtk-lk/platform/common/log_store/log_store_lk.c

/* This software/firmware and related documentation ("MediaTek Software") are
* protected under relevant copyright laws. The information contained herein is
* confidential and proprietary to MediaTek Inc. and/or its licensors. Without
* the prior written permission of MediaTek inc. and/or its licensors, any
* reproduction, modification, use or disclosure of MediaTek Software, and
* information contained herein, in whole or in part, shall be strictly
* prohibited.
*
* MediaTek Inc. (C) 2010. All rights reserved.
*
* BY OPENING THIS FILE, RECEIVER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
* THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE")
* RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO RECEIVER
* ON AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL
* WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR
* NONINFRINGEMENT. NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH
* RESPECT TO THE SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY,
* INCORPORATED IN, OR SUPPLIED WITH THE MEDIATEK SOFTWARE, AND RECEIVER AGREES
* TO LOOK ONLY TO SUCH THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO.
* RECEIVER EXPRESSLY ACKNOWLEDGES THAT IT IS RECEIVER'S SOLE RESPONSIBILITY TO
* OBTAIN FROM ANY THIRD PARTY ALL PROPER LICENSES CONTAINED IN MEDIATEK
* SOFTWARE. MEDIATEK SHALL ALSO NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE
* RELEASES MADE TO RECEIVER'S SPECIFICATION OR TO CONFORM TO A PARTICULAR
* STANDARD OR OPEN FORUM. RECEIVER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S
* ENTIRE AND CUMULATIVE LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE
* RELEASED HEREUNDER WILL BE, AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE
* MEDIATEK SOFTWARE AT ISSUE, OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE
* CHARGE PAID BY RECEIVER TO MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
*
* The following software/firmware and/or related documentation ("MediaTek
* Software") have been modified by MediaTek Inc. All revisions are subject to
* any receiver's applicable license agreements with MediaTek Inc.
*/
#include <stdlib.h>
#include <arch/arm/mmu.h>
#include "log_store_lk.h"
#ifdef MTK_GPT_SCHEME_SUPPORT
#include <platform/partition.h>
#else
#include <mt_partition.h>
#endif
#include "part_interface.h"
#include "block_generic_interface.h"
#include <bootargs.h>
#include "mt_pmic.h"

#define MOD "LK_LOG_STORE"

#define DEBUG_LOG
#define EMMC_LOG_BUF_SIZE (0x200000)

#ifdef DEBUG_LOG
#define LOG_DEBUG(fmt, ...) \
    log_store_enable = false; \
    _dprintf(fmt, ##__VA_ARGS__); \
    log_store_enable = true
#else
#define LOG_DEBUG(fmt, ...)
#endif

/* !!!!!!! Because log store be called by print, so these function don't use print log to debug.*/

enum {
	LOG_WRITE = 0x1,        /* Log is write to buff */
	LOG_READ_KERNEL = 0x2,  /* Log have readed by kernel */
	LOG_WRITE_EMMC = 0x4,   /* log need save to emmc */
	LOG_EMPTY = 0x8,        /* log is empty */
	LOG_FULL = 0x10,        /* log is full */
	LOG_PL_FINISH = 0X20,   /* pl boot up finish */
	LOG_LK_FINISH = 0X40,   /* lk boot up finish */
	LOG_DEFAULT = LOG_WRITE_EMMC|LOG_EMPTY,
} BLOG_FLAG;

static int log_store_status = BUFF_NOT_READY;
static struct pl_lk_log *dram_curlog_header;
static struct sram_log_header *sram_header;
static char *pbuff;
static struct dram_buf_header *sram_dram_buff;
bool log_store_enable = true;
static bool lk_is_full = false;
static u32 lk_renew;
u64 part_end;
off_t part_size;
#if defined(MTK_NEW_COMBO_EMMC_SUPPORT) || defined(MTK_TLC_NAND_SUPPORT) || defined(MTK_MLC_NAND_SUPPORT) || defined(MTK_UFS_SUPPORT)
int part_id;
#endif
static u32 last_boot_phase;

u32 set_pmic_boot_phase(u32 boot_phase)
{
	u32 ret;
	boot_phase = boot_phase & BOOT_PHASE_MASK;
	log_store_enable = false;
	ret = pmic_config_interface(0xA0E, boot_phase, BOOT_PHASE_MASK, PMIC_BOOT_PHASE_SHIFT);
	log_store_enable = true;
	return ret;
}

u32 get_pmic_boot_phase()
{
	u32 value = 0, ret;
	ret = pmic_read_interface(0xA0E, &value, BOOT_PHASE_MASK, PMIC_LAST_BOOT_PHASE_SHIFT);
	if (ret == 0)
		last_boot_phase = value;
	return value;
}
void log_store_init(void)
{
	unsigned int addr, size;

	LOG_DEBUG("%s:lk log_store_init start.\n", MOD);

	if (log_store_status != BUFF_NOT_READY) {
		LOG_DEBUG("%s:log_sotore_status is ready!\n", MOD);
		return;
	}

	/* SRAM buff header init */
	sram_log_store_addr_size(&addr, &size);
	sram_header = (struct sram_log_header *)addr;
	if (sram_header->sig != SRAM_HEADER_SIG) {
		LOG_DEBUG("%s:sram header 0x%x is not match: %d!\n", MOD, (unsigned int)sram_header, sram_header->sig);
		memset(sram_header, 0, sizeof(struct sram_log_header));
		sram_header->sig = SRAM_HEADER_SIG;
		log_store_status = BUFF_ALLOC_ERROR;
		return;
	}

	sram_dram_buff = &(sram_header->dram_buf);
	if (sram_dram_buff->sig != DRAM_HEADER_SIG || sram_dram_buff->flag == BUFF_ALLOC_ERROR) {
		log_store_status = BUFF_ALLOC_ERROR;
		LOG_DEBUG("%s:sram_dram_buff 0x%x, sig 0x%x, flag 0x%x.\n", MOD,
		          (unsigned int)sram_dram_buff, (unsigned int)sram_dram_buff->sig, (unsigned int)sram_dram_buff->flag);
		return;
	}

	pbuff = (char *)sram_dram_buff->buf_addr;
	dram_curlog_header = (struct pl_lk_log*)&(sram_header->dram_curlog_header);

#ifdef MTK_3LEVEL_PAGETABLE
	uint32_t start = ROUNDDOWN((uint32_t)pbuff, PAGE_SIZE);
	uint32_t logsize = ROUNDUP(((uint32_t)pbuff - start + LOG_STORE_SIZE), PAGE_SIZE);
	LOG_DEBUG("%s:dram pl/lk log buff mapping start addr = 0x%x, size = 0x%x\n", MOD, start, logsize);
	if (start >= DRAM_PHY_ADDR) {
		/*need to use header in DRAZM, we must allocate it first */
		log_store_enable = false;
		arch_mmu_map((uint64_t) start, start,
		             MMU_MEMORY_TYPE_DEVICE | MMU_MEMORY_AP_P_RW_U_NA, logsize);
		log_store_enable = true;
	}
#endif

	LOG_DEBUG("%s:sram buff header 0x%x,current log header 0x%x, sig 0x%x, buff_size 0x%x, pl log size 0x%x@0x%x, lk log size 0x%x@0x%x!\n",
	          MOD, (unsigned int)sram_header, (unsigned int)dram_curlog_header, (unsigned int)dram_curlog_header->sig, (unsigned int)dram_curlog_header->buff_size,
	          (unsigned int)dram_curlog_header->sz_pl, (unsigned int)dram_curlog_header->off_pl, (unsigned int)dram_curlog_header->sz_lk, (unsigned int)dram_curlog_header->off_lk);

	if (dram_curlog_header->sig != LOG_STORE_SIG || dram_curlog_header->buff_size != LOG_STORE_SIZE
	        || dram_curlog_header->off_pl != sizeof(struct pl_lk_log)) {
		log_store_status = BUFF_ERROR;
		LOG_DEBUG("%s: BUFF_ERROR, sig 0x%x, buff_size 0x%x, off_pl 0x%x.\n", MOD,
		          dram_curlog_header->sig, dram_curlog_header->buff_size, dram_curlog_header->off_pl);
		return;
	}

	if (dram_curlog_header->sz_pl + sizeof(struct pl_lk_log) >= LOG_STORE_SIZE) {
		LOG_DEBUG("%s: buff full pl size 0x%x.\n", MOD, dram_curlog_header->sz_pl);
		log_store_status = BUFF_FULL;
		return;
	}

	dram_curlog_header->off_lk = sizeof(struct pl_lk_log) + dram_curlog_header->sz_pl;
	dram_curlog_header->sz_lk = 0;
	dram_curlog_header->lk_flag = LOG_DEFAULT;


	log_store_status = BUFF_READY;
	LOG_DEBUG("%s: buff ready.\n", MOD);
}

void lk_log_store(char c)
{
	if (log_store_enable == false)
		return;

	if (log_store_status == BUFF_NOT_READY)
		log_store_init();

	if ((log_store_status != BUFF_READY) || (log_store_status == BUFF_FULL))
		return;

	if (lk_is_full) {
		if (lk_renew >= dram_curlog_header->sz_lk) lk_renew = 0;
		*(pbuff + dram_curlog_header->off_lk + lk_renew) = c;
		lk_renew++;
	} else {
		*(pbuff + dram_curlog_header->off_lk + dram_curlog_header->sz_lk) = c;
		dram_curlog_header->sz_lk++;
		if ((dram_curlog_header->off_lk + dram_curlog_header->sz_lk) >= LOG_STORE_SIZE) {
			lk_is_full = true;
			lk_renew = 0;
			LOG_DEBUG("%s: dram lk buff full", MOD);
		}
	}

	sram_dram_buff->buf_point = dram_curlog_header->sz_lk + dram_curlog_header->sz_pl;
}

u32 current_buf_addr_get(void)
{
	return sram_dram_buff->buf_addr;
}

u32 current_lk_buf_addr_get(void)
{
	return (sram_dram_buff->buf_addr + dram_curlog_header->off_lk);
}

u32 current_buf_pl_lk_log_size_get(void)
{
	return (dram_curlog_header->sz_pl + dram_curlog_header->sz_lk);
}

inline void expdb_write(off_t offset, u8 *buf, size_t size)
{
	log_store_enable = false;
	int ret = partition_write("expdb", offset, buf, size);
	LOG_DEBUG("%s: %s offset %lld size %zu ret value = %zu\n", MOD, __func__, offset, size, ret);
	log_store_enable = true;
}

inline void expdb_read(part_dev_t *dev, u64 offset, uchar *buf, u64 size)
{
	log_store_enable = false;
#if defined(MTK_EMMC_SUPPORT) || defined(MTK_UFS_SUPPORT)
#if defined(MTK_NEW_COMBO_EMMC_SUPPORT) || defined(MTK_UFS_SUPPORT)
	dev->read(dev, offset, buf, size, part_id);
#else
	dev->read(dev, offset, buf, size);
#endif
#else
	dev->read(dev, offset, buf, size, part_id);
#endif
	log_store_enable = true;
}

/* check emmc log_store config valid, or re-write it */
bool emmc_config_valid(struct log_emmc_header *log_header, u64 block_size)
{
	bool ret = true;

	if (log_header->sig != LOG_EMMC_SIG) {
		memset(log_header, 0, sizeof(struct log_emmc_header));
		log_header->sig = LOG_EMMC_SIG;
		return false;
	}

	if(log_header->offset >= EMMC_LOG_BUF_SIZE - block_size) {
		log_header->offset = 0;
		ret = false;
	}

	return ret;
}

/* read expdb partition and log config header info*/
part_dev_t* read_emmc_config(struct log_emmc_header *log_header)
{
	int index = 0;
	part_dev_t *dev = NULL;

	log_store_enable = false;
	index = partition_get_index("expdb");
	dev = mt_part_get_device();

	if (index == -1 || dev == NULL) {
		LOG_DEBUG("%s: no %s partition[%d]\n", MOD, "expdb", index);
		return NULL;
	}
#if defined(MTK_NEW_COMBO_EMMC_SUPPORT) || defined(MTK_TLC_NAND_SUPPORT) || defined(MTK_MLC_NAND_SUPPORT) || defined(MTK_UFS_SUPPORT)
	part_id = partition_get_region(index);
#endif
	part_end = partition_get_offset(index) + partition_get_size(index);
	part_size = partition_get_size(index);
	log_store_enable = true;

	expdb_read(dev, part_end - dev->blkdev->blksz,
		(uchar *)log_header, sizeof(struct log_emmc_header));

	if (emmc_config_valid(log_header, dev->blkdev->blksz) == false) {
		LOG_DEBUG("%s: %s write emmc\n", MOD, __func__);
		expdb_write(part_size - (off_t)dev->blkdev->blksz,
			(u8 *)log_header, sizeof(struct log_emmc_header));
	}

	return dev;
}

void set_emmc_config(int type, int value)
{
	part_dev_t *dev = NULL;
	struct log_emmc_header log_header;

	if (type > EMMC_STORE_FLAG_TYPE_NR) {
		LOG_DEBUG("%s: config type %d is invalid.\n", MOD, type);
		return;
	}
	memset(&log_header, 0, sizeof(log_header));
	if ((dev = read_emmc_config(&log_header)) == NULL)
		return;

	if (type == UART_LOG || type == PRINTK_RATELIMIT || type == KEDUMP_CTL) { 
		if (value)
			log_header.reserve_flag[type] = FLAG_ENABLE;
		else
			log_header.reserve_flag[type] = FLAG_DISABLE;
	} else {
		log_header.reserve_flag[type] = value;
	}
	LOG_DEBUG("%s:%s config type %d value %d.\n", MOD, __func__, type, value);
	expdb_write(part_size - (off_t)dev->blkdev->blksz,
		(u8 *)&log_header, sizeof(struct log_emmc_header));
}

void set_boot_phase(u32 boot_step)
{
	struct log_emmc_header log_header;
	part_dev_t *dev = NULL;

	memset(&log_header, 0, sizeof(struct log_emmc_header));
	if (sram_header->reserve[SRAM_PMIC_BOOT_PHASE] == FLAG_ENABLE){
		set_pmic_boot_phase(boot_step);
		if (last_boot_phase == 0)
			get_pmic_boot_phase();
	}
	if ((dev = read_emmc_config(&log_header)) == NULL)
		return;

	boot_step = boot_step & BOOT_PHASE_MASK;
	// get last boot phase
	if (last_boot_phase == 0)
	last_boot_phase = (log_header.reserve_flag[BOOT_STEP] >> LAST_BOOT_PHASE_SHIFT) & BOOT_PHASE_MASK;
	// clear now boot phase
	log_header.reserve_flag[BOOT_STEP] = log_header.reserve_flag[BOOT_STEP] & (BOOT_PHASE_MASK << LAST_BOOT_PHASE_SHIFT);
	// set now boot phase
	log_header.reserve_flag[BOOT_STEP] = log_header.reserve_flag[BOOT_STEP] | (boot_step << NOW_BOOT_PHASE_SHIFT);

	expdb_write(part_size - dev->blkdev->blksz,	(uchar *)&log_header, sizeof(struct log_emmc_header));
		

	LOG_DEBUG("%s:get last boot flag= 0x%x\n", MOD, last_boot_phase);
}

u32 get_last_boot_phase(void)
{
	return last_boot_phase;
}


void set_uart_log_flag(bool enable)
{
#ifdef	UART_SWITCH_SUPPORT
	set_emmc_config(UART_LOG, enable);
#endif
}

void set_printk_ratelimit(bool enable)
{
	set_emmc_config(PRINTK_RATELIMIT, !enable);
}

void read_ratelimit_config()
{
	struct log_emmc_header log_header;

	memset(&log_header, 0, sizeof(log_header));
	if (read_emmc_config(&log_header) == NULL) {
		dprintf(INFO, "READ PRINTK RATELIMIT CONFIG FAIL!\n");
		return;
	}
	if (log_header.reserve_flag[PRINTK_RATELIMIT] == FLAG_DISABLE) {
		dprintf(INFO, "APPEND KERNEL CMDLINE printk.devkmsg=on\n");
		if (cmdline_append("printk.devkmsg=on") != true) {
			dprintf(CRITICAL, "set printk.devkmsg=on fail!");
			return;
		}
		dprintf(INFO, "set printk.devkmsg=on success\n");
		}
	
}

int read_kedump_config()
{
	struct log_emmc_header log_header;

	memset(&log_header, 0, sizeof(log_header));
	if (read_emmc_config(&log_header) == NULL) {
		dprintf(INFO, "READ KEDUMP CONFIG FAIL!\n");
		return 0;
	}

	if (log_header.reserve_flag[KEDUMP_CTL] == FLAG_DISABLE) {
		dprintf(INFO, "kedump is disabled!\n");
		return 0;
	}

	return 1;
}
/* exception power off in lk phase, sava log to emmc to analyze*/
#ifndef DRAM_PHY_ADDR
#define DRAM_PHY_ADDR (0x40000000)
#endif
void save_pllk_log(void)
{
	u32 add;
	size_t size = 0, emmc_remain_buf_size = 0;
	part_dev_t *dev = NULL;
	struct log_emmc_header log_header;
	struct emmc_log emmc_log;

	LOG_DEBUG("%s: start save pllk log.\n", MOD);

	memset(&log_header, 0, sizeof(log_header));
	if ((dev = read_emmc_config(&log_header)) == NULL) {
		LOG_DEBUG("%s: read_emmc_config not correct.\n", MOD);
		return;
	}

	add = sram_dram_buff->buf_addr;
	size = dram_curlog_header->sz_pl + dram_curlog_header->sz_lk;
	if (add < DRAM_PHY_ADDR) {
		LOG_DEBUG("%s: sram_dram_buff->buf_addr not correct.\n", MOD);
		return;
	}

	if (size > EMMC_LOG_BUF_SIZE/4) {
		/* store size max 0.25 emm log, now is 512K */
		add = add + (size - EMMC_LOG_BUF_SIZE/4);
		size = EMMC_LOG_BUF_SIZE/4;
	}

	if (size % 4 != 0)
		size = size + 4 - size % 4;

	emmc_remain_buf_size = EMMC_LOG_BUF_SIZE - dev->blkdev->blksz - log_header.offset;
	emmc_log.start = log_header.offset;

	LOG_DEBUG("%s: part_size %lld.\n", MOD, part_size);
	if (size > emmc_remain_buf_size) {
		LOG_DEBUG("%s: size > emmc_remain_buf_size write emmc.\n", MOD);
		expdb_write(part_size - (off_t)EMMC_LOG_BUF_SIZE + (off_t)log_header.offset, (u8 *)add, emmc_remain_buf_size);
		expdb_write(part_size - (off_t)EMMC_LOG_BUF_SIZE, (u8 *)(add + emmc_remain_buf_size), size - emmc_remain_buf_size);
		log_header.offset = size - emmc_remain_buf_size;
	} else {
		LOG_DEBUG("%s: size <= emmc_remain_buf_size write emmc.\n", MOD);
		expdb_write(part_size - (off_t)EMMC_LOG_BUF_SIZE + (off_t)log_header.offset, (u8 *)add, size);
		log_header.offset = log_header.offset + size;
	}

	emmc_log.type = LOG_PLLK;
	emmc_log.end = log_header.offset;
	add = part_size - (off_t)dev->blkdev->blksz + (off_t)sizeof(log_header) + (off_t)log_header.reserve_flag[LOG_INDEX] * (off_t)sizeof(struct emmc_log);
	LOG_DEBUG("%s: config write emmc.\n", MOD);
	expdb_write(add, (u8 *)&emmc_log, sizeof(struct emmc_log));
	log_header.reserve_flag[LOG_INDEX] += 1;
	log_header.reserve_flag[LOG_INDEX] = log_header.reserve_flag[LOG_INDEX] % HEADER_INDEX_MAX;

	/* re-write offset to config*/
	LOG_DEBUG("%s: config re-write emmc.\n", MOD);
	expdb_write(part_size - (off_t)dev->blkdev->blksz,
		(u8 *)&log_header, sizeof(struct log_emmc_header));
	LOG_DEBUG("%s: save pllk log size 0x%x, offset 0x%x.\n", MOD, size, emmc_log.start);
}