[thirdparty/kernel/stable.git] / include / scsi / scsi_transport_spi.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/* 
 *  Parallel SCSI (SPI) transport specific attributes exported to sysfs.
 *
 *  Copyright (c) 2003 Silicon Graphics, Inc.  All rights reserved.
 */
#ifndef SCSI_TRANSPORT_SPI_H
#define SCSI_TRANSPORT_SPI_H

#include <linux/transport_class.h>
#include <linux/mutex.h>

struct scsi_transport_template;
struct scsi_target;
struct scsi_device;
struct Scsi_Host;

struct spi_transport_attrs {
	int period;		/* value in the PPR/SDTR command */
	int min_period;
	int offset;
	int max_offset;
	unsigned int width:1;	/* 0 - narrow, 1 - wide */
	unsigned int max_width:1;
	unsigned int iu:1;	/* Information Units enabled */
	unsigned int max_iu:1;
	unsigned int dt:1;	/* DT clocking enabled */
	unsigned int qas:1;	/* Quick Arbitration and Selection enabled */
	unsigned int max_qas:1;
	unsigned int wr_flow:1;	/* Write Flow control enabled */
	unsigned int rd_strm:1;	/* Read streaming enabled */
	unsigned int rti:1;	/* Retain Training Information */
	unsigned int pcomp_en:1;/* Precompensation enabled */
	unsigned int hold_mcs:1;/* Hold Margin Control Settings */
	unsigned int initial_dv:1; /* DV done to this target yet  */
	unsigned long flags;	/* flags field for drivers to use */
	/* Device Properties fields */
	unsigned int support_sync:1; /* synchronous support */
	unsigned int support_wide:1; /* wide support */
	unsigned int support_dt:1; /* allows DT phases */
	unsigned int support_dt_only; /* disallows ST phases */
	unsigned int support_ius; /* support Information Units */
	unsigned int support_qas; /* supports quick arbitration and selection */
	/* Private Fields */
	unsigned int dv_pending:1; /* Internal flag: DV Requested */
	unsigned int dv_in_progress:1;	/* Internal: DV started */
	struct mutex dv_mutex; /* semaphore to serialise dv */
};

enum spi_signal_type {
	SPI_SIGNAL_UNKNOWN = 1,
	SPI_SIGNAL_SE,
	SPI_SIGNAL_LVD,
	SPI_SIGNAL_HVD,
};

struct spi_host_attrs {
	enum spi_signal_type signalling;
};

/* accessor functions */
#define spi_period(x)	(((struct spi_transport_attrs *)&(x)->starget_data)->period)
#define spi_min_period(x) (((struct spi_transport_attrs *)&(x)->starget_data)->min_period)
#define spi_offset(x)	(((struct spi_transport_attrs *)&(x)->starget_data)->offset)
#define spi_max_offset(x) (((struct spi_transport_attrs *)&(x)->starget_data)->max_offset)
#define spi_width(x)	(((struct spi_transport_attrs *)&(x)->starget_data)->width)
#define spi_max_width(x) (((struct spi_transport_attrs *)&(x)->starget_data)->max_width)
#define spi_iu(x)	(((struct spi_transport_attrs *)&(x)->starget_data)->iu)
#define spi_max_iu(x)	(((struct spi_transport_attrs *)&(x)->starget_data)->max_iu)
#define spi_dt(x)	(((struct spi_transport_attrs *)&(x)->starget_data)->dt)
#define spi_qas(x)	(((struct spi_transport_attrs *)&(x)->starget_data)->qas)
#define spi_max_qas(x)	(((struct spi_transport_attrs *)&(x)->starget_data)->max_qas)
#define spi_wr_flow(x)	(((struct spi_transport_attrs *)&(x)->starget_data)->wr_flow)
#define spi_rd_strm(x)	(((struct spi_transport_attrs *)&(x)->starget_data)->rd_strm)
#define spi_rti(x)	(((struct spi_transport_attrs *)&(x)->starget_data)->rti)
#define spi_pcomp_en(x)	(((struct spi_transport_attrs *)&(x)->starget_data)->pcomp_en)
#define spi_hold_mcs(x)	(((struct spi_transport_attrs *)&(x)->starget_data)->hold_mcs)
#define spi_initial_dv(x)	(((struct spi_transport_attrs *)&(x)->starget_data)->initial_dv)
#define spi_dv_pending(x) (((struct spi_transport_attrs *)&(x)->starget_data)->dv_pending)

#define spi_support_sync(x)	(((struct spi_transport_attrs *)&(x)->starget_data)->support_sync)
#define spi_support_wide(x)	(((struct spi_transport_attrs *)&(x)->starget_data)->support_wide)
#define spi_support_dt(x)	(((struct spi_transport_attrs *)&(x)->starget_data)->support_dt)
#define spi_support_dt_only(x)	(((struct spi_transport_attrs *)&(x)->starget_data)->support_dt_only)
#define spi_support_ius(x)	(((struct spi_transport_attrs *)&(x)->starget_data)->support_ius)
#define spi_support_qas(x)	(((struct spi_transport_attrs *)&(x)->starget_data)->support_qas)

#define spi_flags(x)	(((struct spi_transport_attrs *)&(x)->starget_data)->flags)
#define spi_signalling(h)	(((struct spi_host_attrs *)(h)->shost_data)->signalling)


/* The functions by which the transport class and the driver communicate */
struct spi_function_template {
	void	(*get_period)(struct scsi_target *);
	void	(*set_period)(struct scsi_target *, int);
	void	(*get_offset)(struct scsi_target *);
	void	(*set_offset)(struct scsi_target *, int);
	void	(*get_width)(struct scsi_target *);
	void	(*set_width)(struct scsi_target *, int);
	void	(*get_iu)(struct scsi_target *);
	void	(*set_iu)(struct scsi_target *, int);
	void	(*get_dt)(struct scsi_target *);
	void	(*set_dt)(struct scsi_target *, int);
	void	(*get_qas)(struct scsi_target *);
	void	(*set_qas)(struct scsi_target *, int);
	void	(*get_wr_flow)(struct scsi_target *);
	void	(*set_wr_flow)(struct scsi_target *, int);
	void	(*get_rd_strm)(struct scsi_target *);
	void	(*set_rd_strm)(struct scsi_target *, int);
	void	(*get_rti)(struct scsi_target *);
	void	(*set_rti)(struct scsi_target *, int);
	void	(*get_pcomp_en)(struct scsi_target *);
	void	(*set_pcomp_en)(struct scsi_target *, int);
	void	(*get_hold_mcs)(struct scsi_target *);
	void	(*set_hold_mcs)(struct scsi_target *, int);
	void	(*get_signalling)(struct Scsi_Host *);
	void	(*set_signalling)(struct Scsi_Host *, enum spi_signal_type);
	int	(*deny_binding)(struct scsi_target *);
	/* The driver sets these to tell the transport class it
	 * wants the attributes displayed in sysfs.  If the show_ flag
	 * is not set, the attribute will be private to the transport
	 * class */
	unsigned long	show_period:1;
	unsigned long	show_offset:1;
	unsigned long	show_width:1;
	unsigned long	show_iu:1;
	unsigned long	show_dt:1;
	unsigned long	show_qas:1;
	unsigned long	show_wr_flow:1;
	unsigned long	show_rd_strm:1;
	unsigned long	show_rti:1;
	unsigned long	show_pcomp_en:1;
	unsigned long	show_hold_mcs:1;
};

struct scsi_transport_template *spi_attach_transport(struct spi_function_template *);
void spi_release_transport(struct scsi_transport_template *);
void spi_schedule_dv_device(struct scsi_device *);
void spi_dv_device(struct scsi_device *);
void spi_display_xfer_agreement(struct scsi_target *);
int spi_print_msg(const unsigned char *);
int spi_populate_width_msg(unsigned char *msg, int width);
int spi_populate_sync_msg(unsigned char *msg, int period, int offset);
int spi_populate_ppr_msg(unsigned char *msg, int period, int offset, int width,
		int options);
int spi_populate_tag_msg(unsigned char *msg, struct scsi_cmnd *cmd);

#endif /* SCSI_TRANSPORT_SPI_H */
Commit	Line	Data
1a59d1b8	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
1da177e4 LT	2	/*
	3	* Parallel SCSI (SPI) transport specific attributes exported to sysfs.
	4	*
	5	* Copyright (c) 2003 Silicon Graphics, Inc. All rights reserved.
1da177e4 LT	6	*/
	7	#ifndef SCSI_TRANSPORT_SPI_H
	8	#define SCSI_TRANSPORT_SPI_H
	9
1da177e4	10	#include <linux/transport_class.h>
c8d338c8	11	#include <linux/mutex.h>
1da177e4 LT	12
1da177e4 LT	13	struct scsi_transport_template;
829b8467 MW	14	struct scsi_target;
	15	struct scsi_device;
	16	struct Scsi_Host;
1da177e4 LT	17
	18	struct spi_transport_attrs {
	19	int period; /* value in the PPR/SDTR command */
62a86129	20	int min_period;
1da177e4	21	int offset;
62a86129	22	int max_offset;
1da177e4	23	unsigned int width:1; /* 0 - narrow, 1 - wide */
62a86129	24	unsigned int max_width:1;
1da177e4	25	unsigned int iu:1; /* Information Units enabled */
ea443190	26	unsigned int max_iu:1;
1da177e4 LT	27	unsigned int dt:1; /* DT clocking enabled */
1da177e4 LT	28	unsigned int qas:1; /* Quick Arbitration and Selection enabled */
ea443190	29	unsigned int max_qas:1;
1da177e4 LT	30	unsigned int wr_flow:1; /* Write Flow control enabled */
	31	unsigned int rd_strm:1; /* Read streaming enabled */
	32	unsigned int rti:1; /* Retain Training Information */
	33	unsigned int pcomp_en:1;/* Precompensation enabled */
d872ebe4	34	unsigned int hold_mcs:1;/* Hold Margin Control Settings */
1da177e4 LT	35	unsigned int initial_dv:1; /* DV done to this target yet */
	36	unsigned long flags; /* flags field for drivers to use */
	37	/* Device Properties fields */
	38	unsigned int support_sync:1; /* synchronous support */
	39	unsigned int support_wide:1; /* wide support */
	40	unsigned int support_dt:1; /* allows DT phases */
	41	unsigned int support_dt_only; /* disallows ST phases */
	42	unsigned int support_ius; /* support Information Units */
	43	unsigned int support_qas; /* supports quick arbitration and selection */
	44	/* Private Fields */
dfdc58ba JB	45	unsigned int dv_pending:1; /* Internal flag: DV Requested */
dfdc58ba JB	46	unsigned int dv_in_progress:1; /* Internal: DV started */
d158d261	47	struct mutex dv_mutex; /* semaphore to serialise dv */
1da177e4 LT	48	};
	49
	50	enum spi_signal_type {
	51	SPI_SIGNAL_UNKNOWN = 1,
	52	SPI_SIGNAL_SE,
	53	SPI_SIGNAL_LVD,
	54	SPI_SIGNAL_HVD,
	55	};
	56
	57	struct spi_host_attrs {
	58	enum spi_signal_type signalling;
	59	};
	60
	61	/* accessor functions */
	62	#define spi_period(x) (((struct spi_transport_attrs *)&(x)->starget_data)->period)
62a86129	63	#define spi_min_period(x) (((struct spi_transport_attrs *)&(x)->starget_data)->min_period)
1da177e4	64	#define spi_offset(x) (((struct spi_transport_attrs *)&(x)->starget_data)->offset)
62a86129	65	#define spi_max_offset(x) (((struct spi_transport_attrs *)&(x)->starget_data)->max_offset)
1da177e4	66	#define spi_width(x) (((struct spi_transport_attrs *)&(x)->starget_data)->width)
62a86129	67	#define spi_max_width(x) (((struct spi_transport_attrs *)&(x)->starget_data)->max_width)
1da177e4	68	#define spi_iu(x) (((struct spi_transport_attrs *)&(x)->starget_data)->iu)
ea443190	69	#define spi_max_iu(x) (((struct spi_transport_attrs *)&(x)->starget_data)->max_iu)
1da177e4 LT	70	#define spi_dt(x) (((struct spi_transport_attrs *)&(x)->starget_data)->dt)
1da177e4 LT	71	#define spi_qas(x) (((struct spi_transport_attrs *)&(x)->starget_data)->qas)
ea443190	72	#define spi_max_qas(x) (((struct spi_transport_attrs *)&(x)->starget_data)->max_qas)
1da177e4 LT	73	#define spi_wr_flow(x) (((struct spi_transport_attrs *)&(x)->starget_data)->wr_flow)
	74	#define spi_rd_strm(x) (((struct spi_transport_attrs *)&(x)->starget_data)->rd_strm)
	75	#define spi_rti(x) (((struct spi_transport_attrs *)&(x)->starget_data)->rti)
	76	#define spi_pcomp_en(x) (((struct spi_transport_attrs *)&(x)->starget_data)->pcomp_en)
d872ebe4	77	#define spi_hold_mcs(x) (((struct spi_transport_attrs *)&(x)->starget_data)->hold_mcs)
1da177e4	78	#define spi_initial_dv(x) (((struct spi_transport_attrs *)&(x)->starget_data)->initial_dv)
502c62f1	79	#define spi_dv_pending(x) (((struct spi_transport_attrs *)&(x)->starget_data)->dv_pending)
1da177e4 LT	80
	81	#define spi_support_sync(x) (((struct spi_transport_attrs *)&(x)->starget_data)->support_sync)
	82	#define spi_support_wide(x) (((struct spi_transport_attrs *)&(x)->starget_data)->support_wide)
	83	#define spi_support_dt(x) (((struct spi_transport_attrs *)&(x)->starget_data)->support_dt)
	84	#define spi_support_dt_only(x) (((struct spi_transport_attrs *)&(x)->starget_data)->support_dt_only)
	85	#define spi_support_ius(x) (((struct spi_transport_attrs *)&(x)->starget_data)->support_ius)
	86	#define spi_support_qas(x) (((struct spi_transport_attrs *)&(x)->starget_data)->support_qas)
	87
	88	#define spi_flags(x) (((struct spi_transport_attrs *)&(x)->starget_data)->flags)
	89	#define spi_signalling(h) (((struct spi_host_attrs *)(h)->shost_data)->signalling)
	90
	91
	92
	93	/* The functions by which the transport class and the driver communicate */
	94	struct spi_function_template {
	95	void (get_period)(struct scsi_target );
	96	void (set_period)(struct scsi_target , int);
	97	void (get_offset)(struct scsi_target );
	98	void (set_offset)(struct scsi_target , int);
	99	void (get_width)(struct scsi_target );
	100	void (set_width)(struct scsi_target , int);
	101	void (get_iu)(struct scsi_target );
	102	void (set_iu)(struct scsi_target , int);
	103	void (get_dt)(struct scsi_target );
	104	void (set_dt)(struct scsi_target , int);
	105	void (get_qas)(struct scsi_target );
	106	void (set_qas)(struct scsi_target , int);
	107	void (get_wr_flow)(struct scsi_target );
	108	void (set_wr_flow)(struct scsi_target , int);
	109	void (get_rd_strm)(struct scsi_target );
	110	void (set_rd_strm)(struct scsi_target , int);
	111	void (get_rti)(struct scsi_target );
	112	void (set_rti)(struct scsi_target , int);
	113	void (get_pcomp_en)(struct scsi_target );
	114	void (set_pcomp_en)(struct scsi_target , int);
d872ebe4 JB	115	void (get_hold_mcs)(struct scsi_target );
d872ebe4 JB	116	void (set_hold_mcs)(struct scsi_target , int);
1da177e4 LT	117	void (get_signalling)(struct Scsi_Host );
1da177e4 LT	118	void (set_signalling)(struct Scsi_Host , enum spi_signal_type);
10c1b889	119	int (deny_binding)(struct scsi_target );
1da177e4 LT	120	/* The driver sets these to tell the transport class it
	121	* wants the attributes displayed in sysfs. If the show_ flag
	122	* is not set, the attribute will be private to the transport
	123	* class */
	124	unsigned long show_period:1;
	125	unsigned long show_offset:1;
	126	unsigned long show_width:1;
	127	unsigned long show_iu:1;
	128	unsigned long show_dt:1;
	129	unsigned long show_qas:1;
	130	unsigned long show_wr_flow:1;
	131	unsigned long show_rd_strm:1;
	132	unsigned long show_rti:1;
	133	unsigned long show_pcomp_en:1;
d872ebe4	134	unsigned long show_hold_mcs:1;
1da177e4 LT	135	};
	136
	137	struct scsi_transport_template spi_attach_transport(struct spi_function_template );
	138	void spi_release_transport(struct scsi_transport_template *);
	139	void spi_schedule_dv_device(struct scsi_device *);
	140	void spi_dv_device(struct scsi_device *);
	141	void spi_display_xfer_agreement(struct scsi_target *);
1abfd370	142	int spi_print_msg(const unsigned char *);
6ea3c0b2 MW	143	int spi_populate_width_msg(unsigned char *msg, int width);
	144	int spi_populate_sync_msg(unsigned char *msg, int period, int offset);
	145	int spi_populate_ppr_msg(unsigned char *msg, int period, int offset, int width,
	146	int options);
50668633	147	int spi_populate_tag_msg(unsigned char msg, struct scsi_cmnd cmd);
1da177e4 LT	148
1da177e4 LT	149	#endif /* SCSI_TRANSPORT_SPI_H */