[thirdparty/u-boot.git] / include / bootcount.h

/* SPDX-License-Identifier: GPL-2.0+ */
/*
 * (C) Copyright 2012
 * Stefan Roese, DENX Software Engineering, sr@denx.de.
 */
#ifndef _BOOTCOUNT_H__
#define _BOOTCOUNT_H__

#include <common.h>
#include <asm/io.h>
#include <asm/byteorder.h>
#include <env.h>

#ifdef CONFIG_DM_BOOTCOUNT

struct bootcount_ops {
	/**
	 * get() - get the current bootcount value
	 *
	 * Returns the current counter value of the bootcount backing
	 * store.
	 *
	 * @dev:	Device to read from
	 * @bootcount:	Address to put the current bootcount value
	 */
	int (*get)(struct udevice *dev, u32 *bootcount);

	/**
	 * set() - set a bootcount value (e.g. to reset or increment)
	 *
	 * Sets the value in the bootcount backing store.
	 *
	 * @dev:	Device to read from
	 * @bootcount:	New bootcount value to store
	 */
	int (*set)(struct udevice *dev, const u32 bootcount);
};

/* Access the operations for a bootcount device */
#define bootcount_get_ops(dev)	((struct bootcount_ops *)(dev)->driver->ops)

/**
 * dm_bootcount_get() - Read the current value from a bootcount storage
 *
 * @dev:	Device to read from
 * @bootcount:	Place to put the current bootcount
 * @return 0 if OK, -ve on error
 */
int dm_bootcount_get(struct udevice *dev, u32 *bootcount);

/**
 * dm_bootcount_set() - Write a value to a bootcount storage
 *
 * @dev:	Device to read from
 * @bootcount:  Value to be written to the backing storage
 * @return 0 if OK, -ve on error
 */
int dm_bootcount_set(struct udevice *dev, u32 bootcount);

#endif

/** bootcount_store() - store the current bootcount */
void bootcount_store(ulong);

/**
 * bootcount_load() - load the current bootcount
 *
 * @return bootcount, read from the appropriate location
 */
ulong bootcount_load(void);

#if defined(CONFIG_SPL_BOOTCOUNT_LIMIT) || defined(CONFIG_BOOTCOUNT_LIMIT)

#if !defined(CONFIG_SYS_BOOTCOUNT_LE) && !defined(CONFIG_SYS_BOOTCOUNT_BE)
# if __BYTE_ORDER == __LITTLE_ENDIAN
#  define CONFIG_SYS_BOOTCOUNT_LE
# else
#  define CONFIG_SYS_BOOTCOUNT_BE
# endif
#endif

#ifdef CONFIG_SYS_BOOTCOUNT_LE
static inline void raw_bootcount_store(volatile u32 *addr, u32 data)
{
	out_le32(addr, data);
}

static inline u32 raw_bootcount_load(volatile u32 *addr)
{
	return in_le32(addr);
}
#else
static inline void raw_bootcount_store(volatile u32 *addr, u32 data)
{
	out_be32(addr, data);
}

static inline u32 raw_bootcount_load(volatile u32 *addr)
{
	return in_be32(addr);
}
#endif

DECLARE_GLOBAL_DATA_PTR;
static inline int bootcount_error(void)
{
	unsigned long bootcount = bootcount_load();
	unsigned long bootlimit = env_get_ulong("bootlimit", 10, 0);

	if (bootlimit && bootcount > bootlimit) {
		printf("Warning: Bootlimit (%lu) exceeded.", bootlimit);
		if (!(gd->flags & GD_FLG_SPL_INIT))
			printf(" Using altbootcmd.");
		printf("\n");

		return 1;
	}

	return 0;
}

static inline void bootcount_inc(void)
{
	unsigned long bootcount = bootcount_load();

	if (gd->flags & GD_FLG_SPL_INIT) {
		bootcount_store(++bootcount);
		return;
	}

#ifndef CONFIG_SPL_BUILD
	/* Only increment bootcount when no bootcount support in SPL */
#ifndef CONFIG_SPL_BOOTCOUNT_LIMIT
	bootcount_store(++bootcount);
#endif
	env_set_ulong("bootcount", bootcount);
#endif /* !CONFIG_SPL_BUILD */
}

#else
static inline int bootcount_error(void) { return 0; }
static inline void bootcount_inc(void) {}
#endif /* CONFIG_SPL_BOOTCOUNT_LIMIT || CONFIG_BOOTCOUNT_LIMIT */
#endif /* _BOOTCOUNT_H__ */
Commit	Line	Data
83d290c5	1	/* SPDX-License-Identifier: GPL-2.0+ */
0044c42e SR	2	/*
	3	* (C) Copyright 2012
	4	* Stefan Roese, DENX Software Engineering, sr@denx.de.
0044c42e	5	*/
c1cd21db LM	6	#ifndef _BOOTCOUNT_H__
c1cd21db LM	7	#define _BOOTCOUNT_H__
0044c42e SR	8
	9	#include <common.h>
	10	#include <asm/io.h>
	11	#include <asm/byteorder.h>
168068fb	12	#include <env.h>
0044c42e	13
ebb73de1 PT	14	#ifdef CONFIG_DM_BOOTCOUNT
	15
	16	struct bootcount_ops {
	17	/**
	18	* get() - get the current bootcount value
	19	*
	20	* Returns the current counter value of the bootcount backing
	21	* store.
	22	*
	23	* @dev: Device to read from
	24	* @bootcount: Address to put the current bootcount value
	25	*/
	26	int (get)(struct udevice dev, u32 *bootcount);
	27
	28	/**
	29	* set() - set a bootcount value (e.g. to reset or increment)
	30	*
	31	* Sets the value in the bootcount backing store.
	32	*
	33	* @dev: Device to read from
	34	* @bootcount: New bootcount value to store
	35	*/
	36	int (set)(struct udevice dev, const u32 bootcount);
	37	};
	38
	39	/* Access the operations for a bootcount device */
	40	#define bootcount_get_ops(dev) ((struct bootcount_ops *)(dev)->driver->ops)
	41
	42	/**
	43	* dm_bootcount_get() - Read the current value from a bootcount storage
	44	*
	45	* @dev: Device to read from
	46	* @bootcount: Place to put the current bootcount
	47	* @return 0 if OK, -ve on error
	48	*/
	49	int dm_bootcount_get(struct udevice dev, u32 bootcount);
	50
	51	/**
	52	* dm_bootcount_set() - Write a value to a bootcount storage
	53	*
	54	* @dev: Device to read from
	55	* @bootcount: Value to be written to the backing storage
	56	* @return 0 if OK, -ve on error
	57	*/
	58	int dm_bootcount_set(struct udevice *dev, u32 bootcount);
	59
	60	#endif
	61
f0835837 SG	62	/** bootcount_store() - store the current bootcount */
	63	void bootcount_store(ulong);
	64
	65	/**
	66	* bootcount_load() - load the current bootcount
	67	*
	68	* @return bootcount, read from the appropriate location
	69	*/
	70	ulong bootcount_load(void);
	71
0da70412 LM	72	#if defined(CONFIG_SPL_BOOTCOUNT_LIMIT) \|\| defined(CONFIG_BOOTCOUNT_LIMIT)
0da70412 LM	73
0044c42e SR	74	#if !defined(CONFIG_SYS_BOOTCOUNT_LE) && !defined(CONFIG_SYS_BOOTCOUNT_BE)
	75	# if __BYTE_ORDER == __LITTLE_ENDIAN
	76	# define CONFIG_SYS_BOOTCOUNT_LE
	77	# else
	78	# define CONFIG_SYS_BOOTCOUNT_BE
	79	# endif
	80	#endif
	81
	82	#ifdef CONFIG_SYS_BOOTCOUNT_LE
	83	static inline void raw_bootcount_store(volatile u32 *addr, u32 data)
	84	{
	85	out_le32(addr, data);
	86	}
	87
	88	static inline u32 raw_bootcount_load(volatile u32 *addr)
	89	{
	90	return in_le32(addr);
	91	}
	92	#else
	93	static inline void raw_bootcount_store(volatile u32 *addr, u32 data)
	94	{
	95	out_be32(addr, data);
	96	}
	97
	98	static inline u32 raw_bootcount_load(volatile u32 *addr)
	99	{
	100	return in_be32(addr);
	101	}
	102	#endif
0da70412 LM	103
	104	DECLARE_GLOBAL_DATA_PTR;
	105	static inline int bootcount_error(void)
	106	{
	107	unsigned long bootcount = bootcount_load();
	108	unsigned long bootlimit = env_get_ulong("bootlimit", 10, 0);
	109
	110	if (bootlimit && bootcount > bootlimit) {
	111	printf("Warning: Bootlimit (%lu) exceeded.", bootlimit);
	112	if (!(gd->flags & GD_FLG_SPL_INIT))
	113	printf(" Using altbootcmd.");
	114	printf("\n");
	115
	116	return 1;
	117	}
	118
	119	return 0;
	120	}
	121
	122	static inline void bootcount_inc(void)
	123	{
	124	unsigned long bootcount = bootcount_load();
	125
	126	if (gd->flags & GD_FLG_SPL_INIT) {
	127	bootcount_store(++bootcount);
	128	return;
	129	}
	130
	131	#ifndef CONFIG_SPL_BUILD
	132	/* Only increment bootcount when no bootcount support in SPL */
	133	#ifndef CONFIG_SPL_BOOTCOUNT_LIMIT
	134	bootcount_store(++bootcount);
	135	#endif
	136	env_set_ulong("bootcount", bootcount);
	137	#endif /* !CONFIG_SPL_BUILD */
	138	}
	139
0da70412 LM	140	#else
	141	static inline int bootcount_error(void) { return 0; }
	142	static inline void bootcount_inc(void) {}
	143	#endif /* CONFIG_SPL_BOOTCOUNT_LIMIT \|\| CONFIG_BOOTCOUNT_LIMIT */
c1cd21db	144	#endif /* _BOOTCOUNT_H__ */