diff mbox series

[v4,2/4] usb: xhci: Use register defined and field names

Message ID 20190626075509.20445-3-vkoul@kernel.org
State New
Headers show
Series [v4,1/4] usb: xhci: add firmware loader for uPD720201 and uPD720202 w/o ROM | expand

Commit Message

Vinod Koul June 26, 2019, 7:55 a.m. UTC
Instead of using register values and fields lets define them and
use in the driver.

Signed-off-by: Vinod Koul <vkoul@kernel.org>

Cc: Yoshihiro Shimoda <yoshihiro.shimoda.uh@renesas.com>
Cc: Christian Lamparter <chunkeey@googlemail.com>
Tested-by: Christian Lamparter <chunkeey@gmail.com>

---
 drivers/usb/host/xhci-pci.c | 60 ++++++++++++++++++++++++++-----------
 1 file changed, 43 insertions(+), 17 deletions(-)

-- 
2.20.1

Comments

Mathias Nyman June 28, 2019, 9:42 p.m. UTC | #1
On 26.6.2019 10.55, Vinod Koul wrote:
> Instead of using register values and fields lets define them and

> use in the driver.

> 

> Signed-off-by: Vinod Koul <vkoul@kernel.org>

> Cc: Yoshihiro Shimoda <yoshihiro.shimoda.uh@renesas.com>

> Cc: Christian Lamparter <chunkeey@googlemail.com>

> Tested-by: Christian Lamparter <chunkeey@gmail.com>

> ---

>   drivers/usb/host/xhci-pci.c | 60 ++++++++++++++++++++++++++-----------

>   1 file changed, 43 insertions(+), 17 deletions(-)

> 

> diff --git a/drivers/usb/host/xhci-pci.c b/drivers/usb/host/xhci-pci.c

> index 237df5c47fca..0f2574b42cb1 100644

> --- a/drivers/usb/host/xhci-pci.c

> +++ b/drivers/usb/host/xhci-pci.c

> @@ -57,6 +57,27 @@

>   #define PCI_DEVICE_ID_AMD_PROMONTORYA_1			0x43bc

>   #define PCI_DEVICE_ID_ASMEDIA_1042A_XHCI		0x1142

>   

> +#define RENESAS_FW_VERSION				0x6C

> +#define RENESAS_ROM_CONFIG				0xF0

> +#define RENESAS_FW_STATUS				0xF4

> +#define RENESAS_FW_STATUS_MSB				0xF5

> +#define RENESAS_ROM_STATUS				0xF6

> +#define RENESAS_ROM_STATUS_MSB				0xF7

> +#define RENESAS_DATA0					0xF8

> +#define RENESAS_DATA1					0xFC

> +

> +#define RENESAS_FW_VERSION_FIELD			GENMASK(23, 7)

> +#define RENESAS_FW_VERSION_OFFSET			8

> +

> +#define RENESAS_FW_STATUS_DOWNLOAD_ENABLE		BIT(0)

> +#define RENESAS_FW_STATUS_LOCK				BIT(1)

> +#define RENESAS_FW_STATUS_RESULT			GENMASK(6, 4)

> +  #define RENESAS_FW_STATUS_INVALID			0

> +  #define RENESAS_FW_STATUS_SUCCESS			BIT(4)

> +  #define RENESAS_FW_STATUS_ERROR			BIT(5)

> +#define RENESAS_FW_STATUS_SET_DATA0			BIT(8)

> +#define RENESAS_FW_STATUS_SET_DATA1			BIT(9)

> +

>   #define RENESAS_RETRY	10000

>   #define RENESAS_DELAY	10

>   

> @@ -347,7 +368,8 @@ static int renesas_fw_download_image(struct pci_dev *dev,

>   

>   	/* step+1. Read "Set DATAX" and confirm it is cleared. */

>   	for (i = 0; i < RENESAS_RETRY; i++) {

> -		err = pci_read_config_byte(dev, 0xF5, &fw_status);

> +		err = pci_read_config_byte(dev, RENESAS_FW_STATUS_MSB,

> +					   &fw_status);

>   		if (err)

>   			return pcibios_err_to_errno(err);

>   		if (!(fw_status & BIT(data0_or_data1)))

> @@ -362,7 +384,8 @@ static int renesas_fw_download_image(struct pci_dev *dev,

>   	 * step+2. Write FW data to "DATAX".

>   	 * "LSB is left" => force little endian

>   	 */

> -	err = pci_write_config_dword(dev, data0_or_data1 ? 0xFC : 0xF8,

> +	err = pci_write_config_dword(dev, data0_or_data1 ?

> +				     RENESAS_DATA1 : RENESAS_DATA0,

>   				     (__force u32)cpu_to_le32(fw[step]));

>   	if (err)

>   		return pcibios_err_to_errno(err);

> @@ -370,7 +393,8 @@ static int renesas_fw_download_image(struct pci_dev *dev,

>   	udelay(100);

>   

>   	/* step+3. Set "Set DATAX". */

> -	err = pci_write_config_byte(dev, 0xF5, BIT(data0_or_data1));

> +	err = pci_write_config_byte(dev, RENESAS_FW_STATUS_MSB,

> +				    BIT(data0_or_data1));

>   	if (err)

>   		return pcibios_err_to_errno(err);

>   

> @@ -440,7 +464,7 @@ static int renesas_fw_check_running(struct pci_dev *pdev)

>   	 * BIOSes will initialize the device for us. If the device is

>   	 * initialized.

>   	 */

> -	err = pci_read_config_byte(pdev, 0xF4, &fw_state);

> +	err = pci_read_config_byte(pdev, RENESAS_FW_STATUS, &fw_state);

>   	if (err)

>   		return pcibios_err_to_errno(err);

>   

> @@ -449,10 +473,10 @@ static int renesas_fw_check_running(struct pci_dev *pdev)

>   	 * ready we can simply continue. If the FW is not ready, we have

>   	 * to give up.

>   	 */

> -	if (fw_state & BIT(1)) {

> +	if (fw_state & RENESAS_FW_STATUS_LOCK) {

>   		dev_dbg(&pdev->dev, "FW Download Lock is engaged.");

>   

> -		if (fw_state & BIT(4))

> +		if (fw_state & RENESAS_FW_STATUS_SUCCESS)

>   			return 0;

>   

>   		dev_err(&pdev->dev,

> @@ -465,33 +489,33 @@ static int renesas_fw_check_running(struct pci_dev *pdev)

>   	 * with it and it can't be resetted, we have to give up too... and

>   	 * ask for a forgiveness and a reboot.

>   	 */

> -	if (fw_state & BIT(0)) {

> +	if (fw_state & RENESAS_FW_STATUS_DOWNLOAD_ENABLE) {

>   		dev_err(&pdev->dev,

>   			"FW Download Enable is stale. Giving Up (poweroff/reboot needed).");

>   		return -EIO;

>   	}

>   

>   	/* Otherwise, Check the "Result Code" Bits (6:4) and act accordingly */

> -	switch ((fw_state & 0x70)) {

> +	switch (fw_state & RENESAS_FW_STATUS_RESULT) {

>   	case 0: /* No result yet */

>   		dev_dbg(&pdev->dev, "FW is not ready/loaded yet.");

>   

>   		/* tell the caller, that this device needs the firmware. */

>   		return 1;

>   

> -	case BIT(4): /* Success, device should be working. */

> +	case RENESAS_FW_STATUS_SUCCESS: /* Success, device should be working. */

>   		dev_dbg(&pdev->dev, "FW is ready.");

>   		return 0;

>   

> -	case BIT(5): /* Error State */

> +	case RENESAS_FW_STATUS_ERROR: /* Error State */

>   		dev_err(&pdev->dev,

>   			"hardware is in an error state. Giving up (poweroff/reboot needed).");

>   		return -ENODEV;

>   

>   	default: /* All other states are marked as "Reserved states" */

>   		dev_err(&pdev->dev,

> -			"hardware is in an invalid state %x. Giving up (poweroff/reboot needed).",

> -			(fw_state & 0x70) >> 4);

> +			"hardware is in an invalid state %lx. Giving up (poweroff/reboot needed).",

> +			(fw_state & RENESAS_FW_STATUS_RESULT) >> 4);

>   		return -EINVAL;

>   	}

>   }

> @@ -514,7 +538,8 @@ static int renesas_fw_download(struct pci_dev *pdev,

>   	 * 0. Set "FW Download Enable" bit in the

>   	 * "FW Download Control & Status Register" at 0xF4

>   	 */

> -	err = pci_write_config_byte(pdev, 0xF4, BIT(0));

> +	err = pci_write_config_byte(pdev, RENESAS_FW_STATUS,

> +				    RENESAS_FW_STATUS_DOWNLOAD_ENABLE);

>   	if (err)

>   		return pcibios_err_to_errno(err);

>   

> @@ -535,7 +560,8 @@ static int renesas_fw_download(struct pci_dev *pdev,

>   	 * is cleared by the hardware beforehand.

>   	 */

>   	for (i = 0; i < RENESAS_RETRY; i++) {

> -		err = pci_read_config_byte(pdev, 0xF5, &fw_status);

> +		err = pci_read_config_byte(pdev, RENESAS_FW_STATUS_MSB,

> +					   &fw_status);

>   		if (err)

>   			return pcibios_err_to_errno(err);

>   		if (!(fw_status & (BIT(0) | BIT(1))))

> @@ -550,16 +576,16 @@ static int renesas_fw_download(struct pci_dev *pdev,

>   	 * 11. After finishing writing the last data of FW, the

>   	 * System Software must clear "FW Download Enable"

>   	 */

> -	err = pci_write_config_byte(pdev, 0xF4, 0);

> +	err = pci_write_config_byte(pdev, RENESAS_FW_STATUS, 0);

>   	if (err)

>   		return pcibios_err_to_errno(err);

>   

>   	/* 12. Read "Result Code" and confirm it is good. */

>   	for (i = 0; i < RENESAS_RETRY; i++) {

> -		err = pci_read_config_byte(pdev, 0xF4, &fw_status);

> +		err = pci_read_config_byte(pdev, RENESAS_FW_STATUS, &fw_status);

>   		if (err)

>   			return pcibios_err_to_errno(err);

> -		if (fw_status & BIT(4))

> +		if (fw_status & RENESAS_FW_STATUS_SUCCESS)

>   			break;

>   

>   		udelay(RENESAS_DELAY);

> 


Most of this patch should probably be squashed together with the previous patch

-Mathias
diff mbox series

Patch

diff --git a/drivers/usb/host/xhci-pci.c b/drivers/usb/host/xhci-pci.c
index 237df5c47fca..0f2574b42cb1 100644
--- a/drivers/usb/host/xhci-pci.c
+++ b/drivers/usb/host/xhci-pci.c
@@ -57,6 +57,27 @@ 
 #define PCI_DEVICE_ID_AMD_PROMONTORYA_1			0x43bc
 #define PCI_DEVICE_ID_ASMEDIA_1042A_XHCI		0x1142
 
+#define RENESAS_FW_VERSION				0x6C
+#define RENESAS_ROM_CONFIG				0xF0
+#define RENESAS_FW_STATUS				0xF4
+#define RENESAS_FW_STATUS_MSB				0xF5
+#define RENESAS_ROM_STATUS				0xF6
+#define RENESAS_ROM_STATUS_MSB				0xF7
+#define RENESAS_DATA0					0xF8
+#define RENESAS_DATA1					0xFC
+
+#define RENESAS_FW_VERSION_FIELD			GENMASK(23, 7)
+#define RENESAS_FW_VERSION_OFFSET			8
+
+#define RENESAS_FW_STATUS_DOWNLOAD_ENABLE		BIT(0)
+#define RENESAS_FW_STATUS_LOCK				BIT(1)
+#define RENESAS_FW_STATUS_RESULT			GENMASK(6, 4)
+  #define RENESAS_FW_STATUS_INVALID			0
+  #define RENESAS_FW_STATUS_SUCCESS			BIT(4)
+  #define RENESAS_FW_STATUS_ERROR			BIT(5)
+#define RENESAS_FW_STATUS_SET_DATA0			BIT(8)
+#define RENESAS_FW_STATUS_SET_DATA1			BIT(9)
+
 #define RENESAS_RETRY	10000
 #define RENESAS_DELAY	10
 
@@ -347,7 +368,8 @@  static int renesas_fw_download_image(struct pci_dev *dev,
 
 	/* step+1. Read "Set DATAX" and confirm it is cleared. */
 	for (i = 0; i < RENESAS_RETRY; i++) {
-		err = pci_read_config_byte(dev, 0xF5, &fw_status);
+		err = pci_read_config_byte(dev, RENESAS_FW_STATUS_MSB,
+					   &fw_status);
 		if (err)
 			return pcibios_err_to_errno(err);
 		if (!(fw_status & BIT(data0_or_data1)))
@@ -362,7 +384,8 @@  static int renesas_fw_download_image(struct pci_dev *dev,
 	 * step+2. Write FW data to "DATAX".
 	 * "LSB is left" => force little endian
 	 */
-	err = pci_write_config_dword(dev, data0_or_data1 ? 0xFC : 0xF8,
+	err = pci_write_config_dword(dev, data0_or_data1 ?
+				     RENESAS_DATA1 : RENESAS_DATA0,
 				     (__force u32)cpu_to_le32(fw[step]));
 	if (err)
 		return pcibios_err_to_errno(err);
@@ -370,7 +393,8 @@  static int renesas_fw_download_image(struct pci_dev *dev,
 	udelay(100);
 
 	/* step+3. Set "Set DATAX". */
-	err = pci_write_config_byte(dev, 0xF5, BIT(data0_or_data1));
+	err = pci_write_config_byte(dev, RENESAS_FW_STATUS_MSB,
+				    BIT(data0_or_data1));
 	if (err)
 		return pcibios_err_to_errno(err);
 
@@ -440,7 +464,7 @@  static int renesas_fw_check_running(struct pci_dev *pdev)
 	 * BIOSes will initialize the device for us. If the device is
 	 * initialized.
 	 */
-	err = pci_read_config_byte(pdev, 0xF4, &fw_state);
+	err = pci_read_config_byte(pdev, RENESAS_FW_STATUS, &fw_state);
 	if (err)
 		return pcibios_err_to_errno(err);
 
@@ -449,10 +473,10 @@  static int renesas_fw_check_running(struct pci_dev *pdev)
 	 * ready we can simply continue. If the FW is not ready, we have
 	 * to give up.
 	 */
-	if (fw_state & BIT(1)) {
+	if (fw_state & RENESAS_FW_STATUS_LOCK) {
 		dev_dbg(&pdev->dev, "FW Download Lock is engaged.");
 
-		if (fw_state & BIT(4))
+		if (fw_state & RENESAS_FW_STATUS_SUCCESS)
 			return 0;
 
 		dev_err(&pdev->dev,
@@ -465,33 +489,33 @@  static int renesas_fw_check_running(struct pci_dev *pdev)
 	 * with it and it can't be resetted, we have to give up too... and
 	 * ask for a forgiveness and a reboot.
 	 */
-	if (fw_state & BIT(0)) {
+	if (fw_state & RENESAS_FW_STATUS_DOWNLOAD_ENABLE) {
 		dev_err(&pdev->dev,
 			"FW Download Enable is stale. Giving Up (poweroff/reboot needed).");
 		return -EIO;
 	}
 
 	/* Otherwise, Check the "Result Code" Bits (6:4) and act accordingly */
-	switch ((fw_state & 0x70)) {
+	switch (fw_state & RENESAS_FW_STATUS_RESULT) {
 	case 0: /* No result yet */
 		dev_dbg(&pdev->dev, "FW is not ready/loaded yet.");
 
 		/* tell the caller, that this device needs the firmware. */
 		return 1;
 
-	case BIT(4): /* Success, device should be working. */
+	case RENESAS_FW_STATUS_SUCCESS: /* Success, device should be working. */
 		dev_dbg(&pdev->dev, "FW is ready.");
 		return 0;
 
-	case BIT(5): /* Error State */
+	case RENESAS_FW_STATUS_ERROR: /* Error State */
 		dev_err(&pdev->dev,
 			"hardware is in an error state. Giving up (poweroff/reboot needed).");
 		return -ENODEV;
 
 	default: /* All other states are marked as "Reserved states" */
 		dev_err(&pdev->dev,
-			"hardware is in an invalid state %x. Giving up (poweroff/reboot needed).",
-			(fw_state & 0x70) >> 4);
+			"hardware is in an invalid state %lx. Giving up (poweroff/reboot needed).",
+			(fw_state & RENESAS_FW_STATUS_RESULT) >> 4);
 		return -EINVAL;
 	}
 }
@@ -514,7 +538,8 @@  static int renesas_fw_download(struct pci_dev *pdev,
 	 * 0. Set "FW Download Enable" bit in the
 	 * "FW Download Control & Status Register" at 0xF4
 	 */
-	err = pci_write_config_byte(pdev, 0xF4, BIT(0));
+	err = pci_write_config_byte(pdev, RENESAS_FW_STATUS,
+				    RENESAS_FW_STATUS_DOWNLOAD_ENABLE);
 	if (err)
 		return pcibios_err_to_errno(err);
 
@@ -535,7 +560,8 @@  static int renesas_fw_download(struct pci_dev *pdev,
 	 * is cleared by the hardware beforehand.
 	 */
 	for (i = 0; i < RENESAS_RETRY; i++) {
-		err = pci_read_config_byte(pdev, 0xF5, &fw_status);
+		err = pci_read_config_byte(pdev, RENESAS_FW_STATUS_MSB,
+					   &fw_status);
 		if (err)
 			return pcibios_err_to_errno(err);
 		if (!(fw_status & (BIT(0) | BIT(1))))
@@ -550,16 +576,16 @@  static int renesas_fw_download(struct pci_dev *pdev,
 	 * 11. After finishing writing the last data of FW, the
 	 * System Software must clear "FW Download Enable"
 	 */
-	err = pci_write_config_byte(pdev, 0xF4, 0);
+	err = pci_write_config_byte(pdev, RENESAS_FW_STATUS, 0);
 	if (err)
 		return pcibios_err_to_errno(err);
 
 	/* 12. Read "Result Code" and confirm it is good. */
 	for (i = 0; i < RENESAS_RETRY; i++) {
-		err = pci_read_config_byte(pdev, 0xF4, &fw_status);
+		err = pci_read_config_byte(pdev, RENESAS_FW_STATUS, &fw_status);
 		if (err)
 			return pcibios_err_to_errno(err);
-		if (fw_status & BIT(4))
+		if (fw_status & RENESAS_FW_STATUS_SUCCESS)
 			break;
 
 		udelay(RENESAS_DELAY);