[mirror_ubuntu-hirsute-kernel.git] / include / scsi / scsi_transport_spi.h

/* 
 *  Parallel SCSI (SPI) transport specific attributes exported to sysfs.
 *
 *  Copyright (c) 2003 Silicon Graphics, Inc.  All rights reserved.
 *
 *  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; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  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.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
#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 dt:1;	/* DT clocking enabled */
	unsigned int qas:1;	/* Quick Arbitration and Selection enabled */
	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_dt(x)	(((struct spi_transport_attrs *)&(x)->starget_data)->dt)
#define spi_qas(x)	(((struct spi_transport_attrs *)&(x)->starget_data)->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_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);

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