Commit e88e17fd authored by David S. Miller's avatar David S. Miller
Browse files

Merge branch 'r8169-factor-out-firmware-handling' 



Heiner Kallweit says:

====================
r8169: factor out firmware handling

Let's factor out firmware handling into a separate source code file.
This simplifies reading the code and makes clearer what the interface
between driver and firmware handling is.

v2:
- fix small whitespace issue in patch 2
====================

Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parents d28d66e5 8197f9d2

drivers/net/ethernet/realtek/Makefile

+1 −0
Original line number Diff line number Diff line
@@ -6,4 +6,5 @@ 
obj-$(CONFIG_8139CP) += 8139cp.o

obj-$(CONFIG_8139TOO) += 8139too.o

obj-$(CONFIG_ATP) += atp.o

r8169-objs += r8169_main.o r8169_firmware.o

obj-$(CONFIG_R8169) += r8169.o

drivers/net/ethernet/realtek/r8169_firmware.c

0 → 100644
+231 −0
Original line number Diff line number Diff line 
// SPDX-License-Identifier: GPL-2.0-only

/* r8169_firmware.c: RealTek 8169/8168/8101 ethernet driver.

 *

 * Copyright (c) 2002 ShuChen <shuchen@realtek.com.tw>

 * Copyright (c) 2003 - 2007 Francois Romieu <romieu@fr.zoreil.com>

 * Copyright (c) a lot of people too. Please respect their work.

 *

 * See MAINTAINERS file for support contact information.

 */



#include <linux/delay.h>

#include <linux/firmware.h>



#include "r8169_firmware.h"



enum rtl_fw_opcode {

	PHY_READ		= 0x0,

	PHY_DATA_OR		= 0x1,

	PHY_DATA_AND		= 0x2,

	PHY_BJMPN		= 0x3,

	PHY_MDIO_CHG		= 0x4,

	PHY_CLEAR_READCOUNT	= 0x7,

	PHY_WRITE		= 0x8,

	PHY_READCOUNT_EQ_SKIP	= 0x9,

	PHY_COMP_EQ_SKIPN	= 0xa,

	PHY_COMP_NEQ_SKIPN	= 0xb,

	PHY_WRITE_PREVIOUS	= 0xc,

	PHY_SKIPN		= 0xd,

	PHY_DELAY_MS		= 0xe,

};



struct fw_info {

	u32	magic;

	char	version[RTL_VER_SIZE];

	__le32	fw_start;

	__le32	fw_len;

	u8	chksum;

} __packed;



#define FW_OPCODE_SIZE	sizeof(typeof(*((struct rtl_fw_phy_action *)0)->code))



static bool rtl_fw_format_ok(struct rtl_fw *rtl_fw)

{

	const struct firmware *fw = rtl_fw->fw;

	struct fw_info *fw_info = (struct fw_info *)fw->data;

	struct rtl_fw_phy_action *pa = &rtl_fw->phy_action;



	if (fw->size < FW_OPCODE_SIZE)

		return false;



	if (!fw_info->magic) {

		size_t i, size, start;

		u8 checksum = 0;



		if (fw->size < sizeof(*fw_info))

			return false;



		for (i = 0; i < fw->size; i++)

			checksum += fw->data[i];

		if (checksum != 0)

			return false;



		start = le32_to_cpu(fw_info->fw_start);

		if (start > fw->size)

			return false;



		size = le32_to_cpu(fw_info->fw_len);

		if (size > (fw->size - start) / FW_OPCODE_SIZE)

			return false;



		strscpy(rtl_fw->version, fw_info->version, RTL_VER_SIZE);



		pa->code = (__le32 *)(fw->data + start);

		pa->size = size;

	} else {

		if (fw->size % FW_OPCODE_SIZE)

			return false;



		strscpy(rtl_fw->version, rtl_fw->fw_name, RTL_VER_SIZE);



		pa->code = (__le32 *)fw->data;

		pa->size = fw->size / FW_OPCODE_SIZE;

	}



	return true;

}



static bool rtl_fw_data_ok(struct rtl_fw *rtl_fw)

{

	struct rtl_fw_phy_action *pa = &rtl_fw->phy_action;

	size_t index;



	for (index = 0; index < pa->size; index++) {

		u32 action = le32_to_cpu(pa->code[index]);

		u32 regno = (action & 0x0fff0000) >> 16;



		switch (action >> 28) {

		case PHY_READ:

		case PHY_DATA_OR:

		case PHY_DATA_AND:

		case PHY_MDIO_CHG:

		case PHY_CLEAR_READCOUNT:

		case PHY_WRITE:

		case PHY_WRITE_PREVIOUS:

		case PHY_DELAY_MS:

			break;



		case PHY_BJMPN:

			if (regno > index)

				goto out;

			break;

		case PHY_READCOUNT_EQ_SKIP:

			if (index + 2 >= pa->size)

				goto out;

			break;

		case PHY_COMP_EQ_SKIPN:

		case PHY_COMP_NEQ_SKIPN:

		case PHY_SKIPN:

			if (index + 1 + regno >= pa->size)

				goto out;

			break;



		default:

			dev_err(rtl_fw->dev, "Invalid action 0x%08x\n", action);

			return false;

		}

	}



	return true;

out:

	dev_err(rtl_fw->dev, "Out of range of firmware\n");

	return false;

}



void rtl_fw_write_firmware(struct rtl8169_private *tp, struct rtl_fw *rtl_fw)

{

	struct rtl_fw_phy_action *pa = &rtl_fw->phy_action;

	rtl_fw_write_t fw_write = rtl_fw->phy_write;

	rtl_fw_read_t fw_read = rtl_fw->phy_read;

	int predata = 0, count = 0;

	size_t index;



	for (index = 0; index < pa->size; index++) {

		u32 action = le32_to_cpu(pa->code[index]);

		u32 data = action & 0x0000ffff;

		u32 regno = (action & 0x0fff0000) >> 16;

		enum rtl_fw_opcode opcode = action >> 28;



		if (!action)

			break;



		switch (opcode) {

		case PHY_READ:

			predata = fw_read(tp, regno);

			count++;

			break;

		case PHY_DATA_OR:

			predata |= data;

			break;

		case PHY_DATA_AND:

			predata &= data;

			break;

		case PHY_BJMPN:

			index -= (regno + 1);

			break;

		case PHY_MDIO_CHG:

			if (data == 0) {

				fw_write = rtl_fw->phy_write;

				fw_read = rtl_fw->phy_read;

			} else if (data == 1) {

				fw_write = rtl_fw->mac_mcu_write;

				fw_read = rtl_fw->mac_mcu_read;

			}



			break;

		case PHY_CLEAR_READCOUNT:

			count = 0;

			break;

		case PHY_WRITE:

			fw_write(tp, regno, data);

			break;

		case PHY_READCOUNT_EQ_SKIP:

			if (count == data)

				index++;

			break;

		case PHY_COMP_EQ_SKIPN:

			if (predata == data)

				index += regno;

			break;

		case PHY_COMP_NEQ_SKIPN:

			if (predata != data)

				index += regno;

			break;

		case PHY_WRITE_PREVIOUS:

			fw_write(tp, regno, predata);

			break;

		case PHY_SKIPN:

			index += regno;

			break;

		case PHY_DELAY_MS:

			mdelay(data);

			break;

		}

	}

}



void rtl_fw_release_firmware(struct rtl_fw *rtl_fw)

{

	release_firmware(rtl_fw->fw);

}



int rtl_fw_request_firmware(struct rtl_fw *rtl_fw)

{

	int rc;



	rc = request_firmware(&rtl_fw->fw, rtl_fw->fw_name, rtl_fw->dev);

	if (rc < 0)

		goto out;



	if (!rtl_fw_format_ok(rtl_fw) || !rtl_fw_data_ok(rtl_fw)) {

		release_firmware(rtl_fw->fw);

		rc = -EINVAL;

		goto out;

	}



	return 0;

out:

	dev_err(rtl_fw->dev, "Unable to load firmware %s (%d)\n",

		rtl_fw->fw_name, rc);

	return rc;

}

drivers/net/ethernet/realtek/r8169_firmware.h

0 → 100644
+39 −0
Original line number Diff line number Diff line 
/* SPDX-License-Identifier: GPL-2.0-only */

/* r8169_firmware.h: RealTek 8169/8168/8101 ethernet driver.

 *

 * Copyright (c) 2002 ShuChen <shuchen@realtek.com.tw>

 * Copyright (c) 2003 - 2007 Francois Romieu <romieu@fr.zoreil.com>

 * Copyright (c) a lot of people too. Please respect their work.

 *

 * See MAINTAINERS file for support contact information.

 */



#include <linux/device.h>

#include <linux/firmware.h>



struct rtl8169_private;

typedef void (*rtl_fw_write_t)(struct rtl8169_private *tp, int reg, int val);

typedef int (*rtl_fw_read_t)(struct rtl8169_private *tp, int reg);



#define RTL_VER_SIZE		32



struct rtl_fw {

	rtl_fw_write_t phy_write;

	rtl_fw_read_t phy_read;

	rtl_fw_write_t mac_mcu_write;

	rtl_fw_read_t mac_mcu_read;

	const struct firmware *fw;

	const char *fw_name;

	struct device *dev;



	char version[RTL_VER_SIZE];



	struct rtl_fw_phy_action {

		__le32 *code;

		size_t size;

	} phy_action;

};



int rtl_fw_request_firmware(struct rtl_fw *rtl_fw);

void rtl_fw_release_firmware(struct rtl_fw *rtl_fw);

void rtl_fw_write_firmware(struct rtl8169_private *tp, struct rtl_fw *rtl_fw);

drivers/net/ethernet/realtek/r8169.c→drivers/net/ethernet/realtek/r8169_main.c

+3 −240
Original line number Diff line number Diff line
@@ -27,12 +27,13 @@ 
#include <linux/interrupt.h>

#include <linux/dma-mapping.h>

#include <linux/pm_runtime.h>

#include <linux/firmware.h>

#include <linux/prefetch.h>

#include <linux/pci-aspm.h>

#include <linux/ipv6.h>

#include <net/ip6_checksum.h>



#include "r8169_firmware.h"



#define MODULENAME "r8169"



#define FIRMWARE_8168D_1	"rtl_nic/rtl8168d-1.fw"
@@ -626,10 +627,6 @@ struct rtl8169_stats { 
	struct u64_stats_sync	syncp;

};



struct rtl8169_private;

typedef void (*rtl_fw_write_t)(struct rtl8169_private *tp, int reg, int val);

typedef int (*rtl_fw_read_t)(struct rtl8169_private *tp, int reg);



struct rtl8169_private {

	void __iomem *mmio_addr;	/* memory map physical address */

	struct pci_dev *pci_dev;
@@ -671,24 +668,7 @@ struct rtl8169_private { 
	u32 saved_wolopts;



	const char *fw_name;

	struct rtl_fw {

		rtl_fw_write_t phy_write;

		rtl_fw_read_t phy_read;

		rtl_fw_write_t mac_mcu_write;

		rtl_fw_read_t mac_mcu_read;

		const struct firmware *fw;

		const char *fw_name;

		struct device *dev;



#define RTL_VER_SIZE		32



		char version[RTL_VER_SIZE];



		struct rtl_fw_phy_action {

			__le32 *code;

			size_t size;

		} phy_action;

	} *rtl_fw;

	struct rtl_fw *rtl_fw;



	u32 ocp_base;

};
@@ -2300,203 +2280,6 @@ static void __rtl_writephy_batch(struct rtl8169_private *tp, 


#define rtl_writephy_batch(tp, a) __rtl_writephy_batch(tp, a, ARRAY_SIZE(a))



enum rtl_fw_opcode {

	PHY_READ		= 0x0,

	PHY_DATA_OR		= 0x1,

	PHY_DATA_AND		= 0x2,

	PHY_BJMPN		= 0x3,

	PHY_MDIO_CHG		= 0x4,

	PHY_CLEAR_READCOUNT	= 0x7,

	PHY_WRITE		= 0x8,

	PHY_READCOUNT_EQ_SKIP	= 0x9,

	PHY_COMP_EQ_SKIPN	= 0xa,

	PHY_COMP_NEQ_SKIPN	= 0xb,

	PHY_WRITE_PREVIOUS	= 0xc,

	PHY_SKIPN		= 0xd,

	PHY_DELAY_MS		= 0xe,

};



struct fw_info {

	u32	magic;

	char	version[RTL_VER_SIZE];

	__le32	fw_start;

	__le32	fw_len;

	u8	chksum;

} __packed;



#define FW_OPCODE_SIZE	sizeof(typeof(*((struct rtl_fw_phy_action *)0)->code))



static bool rtl_fw_format_ok(struct rtl_fw *rtl_fw)

{

	const struct firmware *fw = rtl_fw->fw;

	struct fw_info *fw_info = (struct fw_info *)fw->data;

	struct rtl_fw_phy_action *pa = &rtl_fw->phy_action;



	if (fw->size < FW_OPCODE_SIZE)

		return false;



	if (!fw_info->magic) {

		size_t i, size, start;

		u8 checksum = 0;



		if (fw->size < sizeof(*fw_info))

			return false;



		for (i = 0; i < fw->size; i++)

			checksum += fw->data[i];

		if (checksum != 0)

			return false;



		start = le32_to_cpu(fw_info->fw_start);

		if (start > fw->size)

			return false;



		size = le32_to_cpu(fw_info->fw_len);

		if (size > (fw->size - start) / FW_OPCODE_SIZE)

			return false;



		strscpy(rtl_fw->version, fw_info->version, RTL_VER_SIZE);



		pa->code = (__le32 *)(fw->data + start);

		pa->size = size;

	} else {

		if (fw->size % FW_OPCODE_SIZE)

			return false;



		strscpy(rtl_fw->version, rtl_fw->fw_name, RTL_VER_SIZE);



		pa->code = (__le32 *)fw->data;

		pa->size = fw->size / FW_OPCODE_SIZE;

	}



	return true;

}



static bool rtl_fw_data_ok(struct rtl_fw *rtl_fw)

{

	struct rtl_fw_phy_action *pa = &rtl_fw->phy_action;

	size_t index;



	for (index = 0; index < pa->size; index++) {

		u32 action = le32_to_cpu(pa->code[index]);

		u32 regno = (action & 0x0fff0000) >> 16;



		switch (action >> 28) {

		case PHY_READ:

		case PHY_DATA_OR:

		case PHY_DATA_AND:

		case PHY_MDIO_CHG:

		case PHY_CLEAR_READCOUNT:

		case PHY_WRITE:

		case PHY_WRITE_PREVIOUS:

		case PHY_DELAY_MS:

			break;



		case PHY_BJMPN:

			if (regno > index)

				goto out;

			break;

		case PHY_READCOUNT_EQ_SKIP:

			if (index + 2 >= pa->size)

				goto out;

			break;

		case PHY_COMP_EQ_SKIPN:

		case PHY_COMP_NEQ_SKIPN:

		case PHY_SKIPN:

			if (index + 1 + regno >= pa->size)

				goto out;

			break;



		default:

			dev_err(rtl_fw->dev, "Invalid action 0x%08x\n", action);

			return false;

		}

	}



	return true;

out:

	dev_err(rtl_fw->dev, "Out of range of firmware\n");

	return false;

}



static void rtl_fw_write_firmware(struct rtl8169_private *tp,

				  struct rtl_fw *rtl_fw)

{

	struct rtl_fw_phy_action *pa = &rtl_fw->phy_action;

	rtl_fw_write_t fw_write = rtl_fw->phy_write;

	rtl_fw_read_t fw_read = rtl_fw->phy_read;

	int predata = 0, count = 0;

	size_t index;



	for (index = 0; index < pa->size; index++) {

		u32 action = le32_to_cpu(pa->code[index]);

		u32 data = action & 0x0000ffff;

		u32 regno = (action & 0x0fff0000) >> 16;

		enum rtl_fw_opcode opcode = action >> 28;



		if (!action)

			break;



		switch (opcode) {

		case PHY_READ:

			predata = fw_read(tp, regno);

			count++;

			break;

		case PHY_DATA_OR:

			predata |= data;

			break;

		case PHY_DATA_AND:

			predata &= data;

			break;

		case PHY_BJMPN:

			index -= (regno + 1);

			break;

		case PHY_MDIO_CHG:

			if (data == 0) {

				fw_write = rtl_fw->phy_write;

				fw_read = rtl_fw->phy_read;

			} else if (data == 1) {

				fw_write = rtl_fw->mac_mcu_write;

				fw_read = rtl_fw->mac_mcu_read;

			}



			break;

		case PHY_CLEAR_READCOUNT:

			count = 0;

			break;

		case PHY_WRITE:

			fw_write(tp, regno, data);

			break;

		case PHY_READCOUNT_EQ_SKIP:

			if (count == data)

				index++;

			break;

		case PHY_COMP_EQ_SKIPN:

			if (predata == data)

				index += regno;

			break;

		case PHY_COMP_NEQ_SKIPN:

			if (predata != data)

				index += regno;

			break;

		case PHY_WRITE_PREVIOUS:

			fw_write(tp, regno, predata);

			break;

		case PHY_SKIPN:

			index += regno;

			break;

		case PHY_DELAY_MS:

			mdelay(data);

			break;

		}

	}

}



static void rtl_fw_release_firmware(struct rtl_fw *rtl_fw)

{

	release_firmware(rtl_fw->fw);

}



static void rtl_release_firmware(struct rtl8169_private *tp)

{

	if (tp->rtl_fw) {
@@ -4254,26 +4037,6 @@ static void rtl_hw_reset(struct rtl8169_private *tp) 
	rtl_udelay_loop_wait_low(tp, &rtl_chipcmd_cond, 100, 100);

}



static int rtl_fw_request_firmware(struct rtl_fw *rtl_fw)

{

	int rc;



	rc = request_firmware(&rtl_fw->fw, rtl_fw->fw_name, rtl_fw->dev);

	if (rc < 0)

		goto out;



	if (!rtl_fw_format_ok(rtl_fw) || !rtl_fw_data_ok(rtl_fw)) {

		release_firmware(rtl_fw->fw);

		goto out;

	}



	return 0;

out:

	dev_err(rtl_fw->dev, "Unable to load firmware %s (%d)\n",

		rtl_fw->fw_name, rc);

	return rc;

}



static void rtl_request_firmware(struct rtl8169_private *tp)

{

	struct rtl_fw *rtl_fw;

CRA Git | Maintained and supported by SUSTech CRA and CCSE