Commit 05f7f1b9 authored by Samuel Holland's avatar Samuel Holland Committed by Martin K. Petersen
Browse files

scsi: 3w-9xxx: Fix endianness issues in command packets 

The controller expects all data it sends/receives to be little-endian.
Therefore, the packet struct definitions should use the __le16/32/64
types. Once those are correct, sparse reports several issues with the
driver code, which are fixed here as well.

The main issue observed was at the call to scsi_set_resid(), where the
byteswapped parameter would eventually trigger the alignment check at
drivers/scsi/sd.c:2009. At that point, the kernel would continuously
complain about an "Unaligned partial completion", and no further I/O could
occur.

This gets the controller working on big endian powerpc64.

Link: https://lore.kernel.org/r/20210427235915.39211-4-samuel@sholland.org


Signed-off-by: default avatarSamuel Holland <samuel@sholland.org>
Signed-off-by: default avatarMartin K. Petersen <martin.petersen@oracle.com>
parent d133b441

drivers/scsi/3w-9xxx.c

+25 −31
Original line number Diff line number Diff line
@@ -303,10 +303,10 @@ static int twa_aen_drain_queue(TW_Device_Extension *tw_dev, int no_check_reset) 


	/* Initialize sglist */

	memset(&sglist, 0, sizeof(TW_SG_Entry));

	sglist[0].length = TW_SECTOR_SIZE;

	sglist[0].address = tw_dev->generic_buffer_phys[request_id];

	sglist[0].length = cpu_to_le32(TW_SECTOR_SIZE);

	sglist[0].address = TW_CPU_TO_SGL(tw_dev->generic_buffer_phys[request_id]);



	if (sglist[0].address & TW_ALIGNMENT_9000_SGL) {

	if (tw_dev->generic_buffer_phys[request_id] & TW_ALIGNMENT_9000_SGL) {

		TW_PRINTK(tw_dev->host, TW_DRIVER, 0x1, "Found unaligned address during AEN drain");

		goto out;

	}
@@ -440,8 +440,8 @@ static int twa_aen_read_queue(TW_Device_Extension *tw_dev, int request_id) 


	/* Initialize sglist */

	memset(&sglist, 0, sizeof(TW_SG_Entry));

	sglist[0].length = TW_SECTOR_SIZE;

	sglist[0].address = tw_dev->generic_buffer_phys[request_id];

	sglist[0].length = cpu_to_le32(TW_SECTOR_SIZE);

	sglist[0].address = TW_CPU_TO_SGL(tw_dev->generic_buffer_phys[request_id]);



	/* Mark internal command */

	tw_dev->srb[request_id] = NULL;
@@ -501,9 +501,8 @@ static void twa_aen_sync_time(TW_Device_Extension *tw_dev, int request_id) 
           Sunday 12:00AM */

	local_time = (ktime_get_real_seconds() - (sys_tz.tz_minuteswest * 60));

	div_u64_rem(local_time - (3 * 86400), 604800, &schedulertime);

	schedulertime = cpu_to_le32(schedulertime % 604800);



	memcpy(param->data, &schedulertime, sizeof(u32));

	memcpy(param->data, &(__le32){cpu_to_le32(schedulertime)}, sizeof(__le32));



	/* Mark internal command */

	tw_dev->srb[request_id] = NULL;
@@ -1004,19 +1003,13 @@ static int twa_fill_sense(TW_Device_Extension *tw_dev, int request_id, int copy_ 
		if (print_host)

			printk(KERN_WARNING "3w-9xxx: scsi%d: ERROR: (0x%02X:0x%04X): %s:%s.\n",

			       tw_dev->host->host_no,

			       TW_MESSAGE_SOURCE_CONTROLLER_ERROR,

			       full_command_packet->header.status_block.error,

			       error_str[0] == '\0' ?

			       twa_string_lookup(twa_error_table,

						 full_command_packet->header.status_block.error) : error_str,

			       TW_MESSAGE_SOURCE_CONTROLLER_ERROR, error,

			       error_str[0] ? error_str : twa_string_lookup(twa_error_table, error),

			       full_command_packet->header.err_specific_desc);

		else

			printk(KERN_WARNING "3w-9xxx: ERROR: (0x%02X:0x%04X): %s:%s.\n",

			       TW_MESSAGE_SOURCE_CONTROLLER_ERROR,

			       full_command_packet->header.status_block.error,

			       error_str[0] == '\0' ?

			       twa_string_lookup(twa_error_table,

						 full_command_packet->header.status_block.error) : error_str,

			       TW_MESSAGE_SOURCE_CONTROLLER_ERROR, error,

			       error_str[0] ? error_str : twa_string_lookup(twa_error_table, error),

			       full_command_packet->header.err_specific_desc);

	}
@@ -1133,12 +1126,11 @@ static int twa_initconnection(TW_Device_Extension *tw_dev, int message_credits, 
	tw_initconnect->opcode__reserved = TW_OPRES_IN(0, TW_OP_INIT_CONNECTION);

	tw_initconnect->request_id = request_id;

	tw_initconnect->message_credits = cpu_to_le16(message_credits);

	tw_initconnect->features = set_features;



	/* Turn on 64-bit sgl support if we need to */

	tw_initconnect->features |= sizeof(dma_addr_t) > 4 ? 1 : 0;

	set_features |= sizeof(dma_addr_t) > 4 ? 1 : 0;



	tw_initconnect->features = cpu_to_le32(tw_initconnect->features);

	tw_initconnect->features = cpu_to_le32(set_features);



	if (set_features & TW_EXTENDED_INIT_CONNECT) {

		tw_initconnect->size = TW_INIT_COMMAND_PACKET_SIZE_EXTENDED;
@@ -1351,8 +1343,10 @@ static irqreturn_t twa_interrupt(int irq, void *dev_instance) 


				/* Report residual bytes for single sgl */

				if ((scsi_sg_count(cmd) <= 1) && (full_command_packet->command.newcommand.status == 0)) {

					if (full_command_packet->command.newcommand.sg_list[0].length < scsi_bufflen(tw_dev->srb[request_id]))

						scsi_set_resid(cmd, scsi_bufflen(cmd) - full_command_packet->command.newcommand.sg_list[0].length);

					u32 length = le32_to_cpu(full_command_packet->command.newcommand.sg_list[0].length);



					if (length < scsi_bufflen(cmd))

						scsi_set_resid(cmd, scsi_bufflen(cmd) - length);

				}



				/* Now complete the io */
@@ -1394,13 +1388,13 @@ static void twa_load_sgl(TW_Device_Extension *tw_dev, TW_Command_Full *full_comm 
	if (TW_OP_OUT(full_command_packet->command.newcommand.opcode__reserved) == TW_OP_EXECUTE_SCSI) {

		newcommand = &full_command_packet->command.newcommand;

		newcommand->request_id__lunl =

			cpu_to_le16(TW_REQ_LUN_IN(TW_LUN_OUT(newcommand->request_id__lunl), request_id));

			TW_REQ_LUN_IN(TW_LUN_OUT(newcommand->request_id__lunl), request_id);

		if (length) {

			newcommand->sg_list[0].address = TW_CPU_TO_SGL(dma_handle + sizeof(TW_Ioctl_Buf_Apache));

			newcommand->sg_list[0].length = cpu_to_le32(length);

		}

		newcommand->sgl_entries__lunh =

			cpu_to_le16(TW_REQ_LUN_IN(TW_LUN_OUT(newcommand->sgl_entries__lunh), length ? 1 : 0));

			TW_REQ_LUN_IN(TW_LUN_OUT(newcommand->sgl_entries__lunh), length ? 1 : 0);

	} else {

		oldcommand = &full_command_packet->command.oldcommand;

		oldcommand->request_id = request_id;
@@ -1835,10 +1829,10 @@ static int twa_scsiop_execute_scsi(TW_Device_Extension *tw_dev, int request_id, 
	if (srb) {

		command_packet->unit = srb->device->id;

		command_packet->request_id__lunl =

			cpu_to_le16(TW_REQ_LUN_IN(srb->device->lun, request_id));

			TW_REQ_LUN_IN(srb->device->lun, request_id);

	} else {

		command_packet->request_id__lunl =

			cpu_to_le16(TW_REQ_LUN_IN(0, request_id));

			TW_REQ_LUN_IN(0, request_id);

		command_packet->unit = 0;

	}
@@ -1870,19 +1864,19 @@ static int twa_scsiop_execute_scsi(TW_Device_Extension *tw_dev, int request_id, 
					}

				}

			}

			command_packet->sgl_entries__lunh = cpu_to_le16(TW_REQ_LUN_IN((srb->device->lun >> 4), scsi_sg_count(tw_dev->srb[request_id])));

			command_packet->sgl_entries__lunh = TW_REQ_LUN_IN((srb->device->lun >> 4), scsi_sg_count(tw_dev->srb[request_id]));

		}

	} else {

		/* Internal cdb post */

		for (i = 0; i < use_sg; i++) {

			command_packet->sg_list[i].address = TW_CPU_TO_SGL(sglistarg[i].address);

			command_packet->sg_list[i].length = cpu_to_le32(sglistarg[i].length);

			command_packet->sg_list[i].address = sglistarg[i].address;

			command_packet->sg_list[i].length = sglistarg[i].length;

			if (command_packet->sg_list[i].address & TW_CPU_TO_SGL(TW_ALIGNMENT_9000_SGL)) {

				TW_PRINTK(tw_dev->host, TW_DRIVER, 0x2f, "Found unaligned sgl address during internal post");

				goto out;

			}

		}

		command_packet->sgl_entries__lunh = cpu_to_le16(TW_REQ_LUN_IN(0, use_sg));

		command_packet->sgl_entries__lunh = TW_REQ_LUN_IN(0, use_sg);

	}



	if (srb) {
@@ -2107,7 +2101,7 @@ static int twa_probe(struct pci_dev *pdev, const struct pci_device_id *dev_id) 
				     TW_PARAM_FWVER, TW_PARAM_FWVER_LENGTH),

	       (char *)twa_get_param(tw_dev, 1, TW_VERSION_TABLE,

				     TW_PARAM_BIOSVER, TW_PARAM_BIOSVER_LENGTH),

	       le32_to_cpu(*(int *)twa_get_param(tw_dev, 2, TW_INFORMATION_TABLE,

	       le32_to_cpu(*(__le32 *)twa_get_param(tw_dev, 2, TW_INFORMATION_TABLE,

				     TW_PARAM_PORTCOUNT, TW_PARAM_PORTCOUNT_LENGTH)));



	/* Try to enable MSI */

drivers/scsi/3w-9xxx.h

+56 −55
Original line number Diff line number Diff line
@@ -435,8 +435,8 @@ static twa_message_type twa_error_table[] = { 


/* request_id: 12, lun: 4 */

#define TW_REQ_LUN_IN(lun, request_id)			\

	(((lun << 12) & 0xf000) | (request_id & 0xfff))

#define TW_LUN_OUT(lun) ((lun >> 12) & 0xf)

	cpu_to_le16(((lun << 12) & 0xf000) | (request_id & 0xfff))

#define TW_LUN_OUT(lun) ((le16_to_cpu(lun) >> 12) & 0xf)



/* Macros */

#define TW_CONTROL_REG_ADDR(x) (x->base_addr)
@@ -483,42 +483,43 @@ printk(KERN_WARNING "3w-9xxx: ERROR: (0x%02X:0x%04X): %s.\n",a,b,c); \ 
#define TW_APACHE_MAX_SGL_LENGTH (sizeof(dma_addr_t) > 4 ? 72 : 109)

#define TW_ESCALADE_MAX_SGL_LENGTH (sizeof(dma_addr_t) > 4 ? 41 : 62)

#define TW_PADDING_LENGTH (sizeof(dma_addr_t) > 4 ? 8 : 0)

#define TW_CPU_TO_SGL(x) (sizeof(dma_addr_t) > 4 ? cpu_to_le64(x) : cpu_to_le32(x))



#if IS_ENABLED(CONFIG_ARCH_DMA_ADDR_T_64BIT)

typedef u64 twa_addr_t;

typedef __le64 twa_addr_t;

#define TW_CPU_TO_SGL(x) cpu_to_le64(x)

#else

typedef u32 twa_addr_t;

typedef __le32 twa_addr_t;

#define TW_CPU_TO_SGL(x) cpu_to_le32(x)

#endif



/* Scatter Gather List Entry */

typedef struct TAG_TW_SG_Entry {

	twa_addr_t	address;

	u32 length;

	__le32		length;

} __packed TW_SG_Entry;



/* Command Packet */

typedef struct TW_Command {

	unsigned char opcode__sgloffset;

	unsigned char size;

	unsigned char request_id;

	unsigned char unit__hostid;

	u8	opcode__sgloffset;

	u8	size;

	u8	request_id;

	u8	unit__hostid;

	/* Second DWORD */

	unsigned char status;

	unsigned char flags;

	u8	status;

	u8	flags;

	union {

		unsigned short block_count;

		unsigned short parameter_count;

		__le16	block_count;

		__le16	parameter_count;

	} byte6_offset;

	union {

		struct {

			u32 lba;

			__le32		lba;

			TW_SG_Entry	sgl[TW_ESCALADE_MAX_SGL_LENGTH];

			twa_addr_t	padding;

		} io;

		struct {

			TW_SG_Entry	sgl[TW_ESCALADE_MAX_SGL_LENGTH];

			u32 padding;

			__le32		padding;

			twa_addr_t	padding2;

		} param;

	} byte8_offset;
@@ -526,31 +527,31 @@ typedef struct TW_Command { 


/* Command Packet for 9000+ controllers */

typedef struct TAG_TW_Command_Apache {

	unsigned char opcode__reserved;

	unsigned char unit;

	unsigned short request_id__lunl;

	unsigned char status;

	unsigned char sgl_offset;

	unsigned short sgl_entries__lunh;

	unsigned char cdb[16];

	u8		opcode__reserved;

	u8		unit;

	__le16		request_id__lunl;

	u8		status;

	u8		sgl_offset;

	__le16		sgl_entries__lunh;

	u8		cdb[16];

	TW_SG_Entry	sg_list[TW_APACHE_MAX_SGL_LENGTH];

	unsigned char padding[TW_PADDING_LENGTH];

	u8		padding[TW_PADDING_LENGTH];

} TW_Command_Apache;



/* New command packet header */

typedef struct TAG_TW_Command_Apache_Header {

	unsigned char sense_data[TW_SENSE_DATA_LENGTH];

	struct {

		char reserved[4];

		unsigned short error;

		unsigned char padding;

		unsigned char severity__reserved;

		u8	reserved[4];

		__le16	error;

		u8	padding;

		u8	severity__reserved;

	} status_block;

	unsigned char err_specific_desc[98];

	struct {

		unsigned char size_header;

		unsigned char reserved[2];

		unsigned char size_sense;

		u8	size_header;

		u8	reserved[2];

		u8	size_sense;

	} header_desc;

} TW_Command_Apache_Header;
@@ -565,19 +566,19 @@ typedef struct TAG_TW_Command_Full { 


/* Initconnection structure */

typedef struct TAG_TW_Initconnect {

	unsigned char opcode__reserved;

	unsigned char size;

	unsigned char request_id;

	unsigned char res2;

	unsigned char status;

	unsigned char flags;

	unsigned short message_credits;

	u32 features;

	unsigned short fw_srl;

	unsigned short fw_arch_id;

	unsigned short fw_branch;

	unsigned short fw_build;

	u32 result;

	u8	opcode__reserved;

	u8	size;

	u8	request_id;

	u8	res2;

	u8	status;

	u8	flags;

	__le16	message_credits;

	__le32	features;

	__le16	fw_srl;

	__le16	fw_arch_id;

	__le16	fw_branch;

	__le16	fw_build;

	__le32	result;

} TW_Initconnect;



/* Event info structure */
@@ -618,11 +619,11 @@ typedef struct TAG_TW_Lock { 


/* GetParam descriptor */

typedef struct {

	unsigned short	table_id;

	unsigned short	parameter_id;

	unsigned short	parameter_size_bytes;

	unsigned short  actual_parameter_size_bytes;

	unsigned char	data[];

	__le16	table_id;

	__le16	parameter_id;

	__le16	parameter_size_bytes;

	__le16  actual_parameter_size_bytes;

	u8	data[];

} TW_Param_Apache, *PTW_Param_Apache;



/* Response queue */