mmio: Add clrsetbitsXX() API in place of updateX()

This patch removes the recently added update8/16/32/64() API and
replaces it with clrsetbits8/16/32/64(). This is more in line with the
existing endian-specific clrsetbits_le16/32/64() functions that have
been used for this task on some platforms already. Rename clrsetbits_8()
to clrsetbits8() to be in line with the new naming.

Keep this stuff in <device/mmio.h> and get rid of <mmio.h> again because
having both is confusing and we seem to have been standardizing on
<device/mmio.h> as the standard arch-independent header that all
platforms should include already.

Also sync libpayload back up with what we have in coreboot. (I'm the
original author of the clrsetbits_le32-definitions so I'm relicensing
them to BSD here.)

Change-Id: Ie4f7b9fdbdf9e8c0174427b4288f79006d56978b
Signed-off-by: Julius Werner <jwerner@chromium.org>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/37432
Reviewed-by: Nico Huber <nico.h@gmx.de>
Reviewed-by: Furquan Shaikh <furquan@google.com>
Reviewed-by: Hung-Te Lin <hungte@chromium.org>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>

payloads/libpayload/include/endian.h

@@ -181,18 +181,47 @@ static inline void le32enc(void *pp, uint32_t u)
 
 /* Handy bit manipulation macros */
 
-#define clrsetbits_le32(addr, clear, set) writel(htole32((le32toh(readl(addr)) \
+#define __clrsetbits(endian, bits, addr, clear, set) \
-	& ~(clear)) | (set)), (addr))
+	write##bits(addr, hto##endian##bits((endian##bits##toh( \
-#define setbits_le32(addr, set) writel(htole32(le32toh(readl(addr)) \
+		read##bits(addr)) & ~((uint##bits##_t)(clear))) | (set)))
-	| (set)), (addr))
-#define clrbits_le32(addr, clear) writel(htole32(le32toh(readl(addr)) \
-	& ~(clear)), (addr))
 
-#define clrsetbits_be32(addr, clear, set) writel(htobe32((be32toh(readl(addr)) \
+#define clrbits_le64(addr, clear)	__clrsetbits(le, 64, addr, clear, 0)
-	& ~(clear)) | (set)), (addr))
+#define clrbits_be64(addr, clear)	__clrsetbits(be, 64, addr, clear, 0)
-#define setbits_be32(addr, set) writel(htobe32(be32toh(readl(addr)) \
+#define clrbits_le32(addr, clear)	__clrsetbits(le, 32, addr, clear, 0)
-	| (set)), (addr))
+#define clrbits_be32(addr, clear)	__clrsetbits(be, 32, addr, clear, 0)
-#define clrbits_be32(addr, clear) writel(htobe32(be32toh(readl(addr)) \
+#define clrbits_le16(addr, clear)	__clrsetbits(le, 16, addr, clear, 0)
-	& ~(clear)), (addr))
+#define clrbits_be16(addr, clear)	__clrsetbits(be, 16, addr, clear, 0)
+
+#define setbits_le64(addr, set)		__clrsetbits(le, 64, addr, 0, set)
+#define setbits_be64(addr, set)		__clrsetbits(be, 64, addr, 0, set)
+#define setbits_le32(addr, set)		__clrsetbits(le, 32, addr, 0, set)
+#define setbits_be32(addr, set)		__clrsetbits(be, 32, addr, 0, set)
+#define setbits_le16(addr, set)		__clrsetbits(le, 16, addr, 0, set)
+#define setbits_be16(addr, set)		__clrsetbits(be, 16, addr, 0, set)
+
+#define clrsetbits_le64(addr, clear, set) __clrsetbits(le, 64, addr, clear, set)
+#define clrsetbits_be64(addr, clear, set) __clrsetbits(be, 64, addr, clear, set)
+#define clrsetbits_le32(addr, clear, set) __clrsetbits(le, 32, addr, clear, set)
+#define clrsetbits_be32(addr, clear, set) __clrsetbits(be, 32, addr, clear, set)
+#define clrsetbits_le16(addr, clear, set) __clrsetbits(le, 16, addr, clear, set)
+#define clrsetbits_be16(addr, clear, set) __clrsetbits(be, 16, addr, clear, set)
+
+#define __clrsetbits_impl(bits, addr, clear, set) write##bits(addr, \
+	(read##bits(addr) & ~((uint##bits##_t)(clear))) | (set))
+
+#define clrsetbits8(addr, clear, set)	__clrsetbits_impl(8, addr, clear, set)
+#define clrsetbits16(addr, clear, set)	__clrsetbits_impl(16, addr, clear, set)
+#define clrsetbits32(addr, clear, set)	__clrsetbits_impl(32, addr, clear, set)
+#define clrsetbits64(addr, clear, set)	__clrsetbits_impl(64, addr, clear, set)
+
+#define setbits8(addr, set)		clrsetbits8(addr, 0, set)
+#define setbits16(addr, set)		clrsetbits16(addr, 0, set)
+#define setbits32(addr, set)		clrsetbits32(addr, 0, set)
+#define setbits64(addr, set)		clrsetbits64(addr, 0, set)
+
+#define clrbits8(addr, clear)		clrsetbits8(addr, clear, 0)
+#define clrbits16(addr, clear)		clrsetbits16(addr, clear, 0)
+#define clrbits32(addr, clear)		clrsetbits32(addr, clear, 0)
+#define clrbits64(addr, clear)		clrsetbits64(addr, clear, 0)
 
 #endif /* _ENDIAN_H_ */

src/drivers/maxim/max77686/max77686.c

@@ -127,10 +127,10 @@ static int max77686_enablereg(unsigned int bus, enum max77686_regnum reg, int en
 	}
 
 	if (enable == REG_DISABLE) {
-		clrbits_8(&read_data,
+		clrbits8(&read_data,
 				pmic->reg_enbitmask << pmic->reg_enbitpos);
 	} else {
-		clrsetbits_8(&read_data,
+		clrsetbits8(&read_data,
 				pmic->reg_enbitmask << pmic->reg_enbitpos,
 				pmic->reg_enbiton << pmic->reg_enbitpos);
 	}
@@ -177,7 +177,7 @@ int max77686_volsetting(unsigned int bus, enum max77686_regnum reg,
 	}
 	vol_level /= (u32)pmic->vol_div;
 
-	clrsetbits_8(&read_data, pmic->vol_bitmask << pmic->vol_bitpos,
+	clrsetbits8(&read_data, pmic->vol_bitmask << pmic->vol_bitpos,
 			vol_level << pmic->vol_bitpos);
 
 	ret = max77686_i2c_write(bus, MAX77686_I2C_ADDR, pmic->vol_addr, read_data);

src/include/device/mmio.h

@@ -19,6 +19,24 @@
 #include <endian.h>
 #include <types.h>
 
+#define __clrsetbits_impl(bits, addr, clear, set) write##bits(addr, \
+	(read##bits(addr) & ~((uint##bits##_t)(clear))) | (set))
+
+#define clrsetbits8(addr, clear, set)	__clrsetbits_impl(8, addr, clear, set)
+#define clrsetbits16(addr, clear, set)	__clrsetbits_impl(16, addr, clear, set)
+#define clrsetbits32(addr, clear, set)	__clrsetbits_impl(32, addr, clear, set)
+#define clrsetbits64(addr, clear, set)	__clrsetbits_impl(64, addr, clear, set)
+
+#define setbits8(addr, set)		clrsetbits8(addr, 0, set)
+#define setbits16(addr, set)		clrsetbits16(addr, 0, set)
+#define setbits32(addr, set)		clrsetbits32(addr, 0, set)
+#define setbits64(addr, set)		clrsetbits64(addr, 0, set)
+
+#define clrbits8(addr, clear)		clrsetbits8(addr, clear, 0)
+#define clrbits16(addr, clear)		clrsetbits16(addr, clear, 0)
+#define clrbits32(addr, clear)		clrsetbits32(addr, clear, 0)
+#define clrbits64(addr, clear)		clrsetbits64(addr, clear, 0)
+
 #ifndef __ROMCC__
 /*
  * Reads a transfer buffer from 32-bit FIFO registers. fifo_stride is the

src/include/endian.h

@@ -79,11 +79,6 @@
 #define clrsetbits_le16(addr, clear, set) __clrsetbits(le, 16, addr, clear, set)
 #define clrsetbits_be16(addr, clear, set) __clrsetbits(be, 16, addr, clear, set)
 
-#define clrsetbits_8(addr, clear, set) \
-	write8(addr, (read8(addr) & ~(clear)) | (set))
-#define clrbits_8(addr, clear) clrsetbits_8(addr, clear, 0)
-#define setbits_8(addr, set) setbits_8(addr, 0, set)
-
 #ifndef __ROMCC__
 /* be16dec/be32dec/be64dec/le16dec/le32dec/le64dec family of functions. */
 #define DEFINE_ENDIAN_DEC(endian, width) \

src/include/mmio.h

@@ -1,45 +0,0 @@
-/*
- * This file is part of the coreboot project.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; version 2 of the License.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- */
-
-/*
- * mmio.h provides update*() as well as read/write*() from arch/mmio.h
- */
-
-#ifndef __MMIO_H__
-#define __MMIO_H__
-
-#include <arch/mmio.h>
-#include <stdint.h>
-
-static __always_inline void update8(volatile void *addr, uint8_t mask, uint8_t or)
-{
-	uint8_t reg = read8(addr);
-	reg = (reg & mask) | or;
-	write8(addr, reg);
-}
-
-static __always_inline void update16(volatile void *addr, uint16_t mask, uint16_t or)
-{
-	uint16_t reg = read16(addr);
-	reg = (reg & mask) | or;
-	write16(addr, reg);
-}
-
-static __always_inline void update32(volatile void *addr, uint32_t mask, uint32_t or)
-{
-	uint32_t reg = read32(addr);
-	reg = (reg & mask) | or;
-	write32(addr, reg);
-}
-
-#endif /* __MMIO_H__ */