[mirror_ubuntu-bionic-kernel.git] / drivers / scsi / arm / queue.h

/*
 *  linux/drivers/acorn/scsi/queue.h: queue handling
 *
 *  Copyright (C) 1997 Russell King
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */
#ifndef QUEUE_H
#define QUEUE_H

typedef struct {
	struct list_head head;
	struct list_head free;
	spinlock_t queue_lock;
	void *alloc;			/* start of allocated mem */
} Queue_t;

/*
 * Function: void queue_initialise (Queue_t *queue)
 * Purpose : initialise a queue
 * Params  : queue - queue to initialise
 */
extern int queue_initialise (Queue_t *queue);

/*
 * Function: void queue_free (Queue_t *queue)
 * Purpose : free a queue
 * Params  : queue - queue to free
 */
extern void queue_free (Queue_t *queue);

/*
 * Function: struct scsi_cmnd *queue_remove (queue)
 * Purpose : removes first SCSI command from a queue
 * Params  : queue   - queue to remove command from
 * Returns : struct scsi_cmnd if successful (and a reference), or NULL if no command available
 */
extern struct scsi_cmnd *queue_remove (Queue_t *queue);

/*
 * Function: struct scsi_cmnd *queue_remove_exclude_ref (queue, exclude)
 * Purpose : remove a SCSI command from a queue
 * Params  : queue   - queue to remove command from
 *	     exclude - array of busy LUNs
 * Returns : struct scsi_cmnd if successful (and a reference), or NULL if no command available
 */
extern struct scsi_cmnd *queue_remove_exclude(Queue_t *queue,
					      unsigned long *exclude);

#define queue_add_cmd_ordered(queue,SCpnt) \
	__queue_add(queue,SCpnt,(SCpnt)->cmnd[0] == REQUEST_SENSE)
#define queue_add_cmd_tail(queue,SCpnt) \
	__queue_add(queue,SCpnt,0)
/*
 * Function: int __queue_add(Queue_t *queue, struct scsi_cmnd *SCpnt, int head)
 * Purpose : Add a new command onto a queue
 * Params  : queue - destination queue
 *	     SCpnt - command to add
 *	     head  - add command to head of queue
 * Returns : 0 on error, !0 on success
 */
extern int __queue_add(Queue_t *queue, struct scsi_cmnd *SCpnt, int head);

/*
 * Function: struct scsi_cmnd *queue_remove_tgtluntag (queue, target, lun, tag)
 * Purpose : remove a SCSI command from the queue for a specified target/lun/tag
 * Params  : queue  - queue to remove command from
 *	     target - target that we want
 *	     lun    - lun on device
 *	     tag    - tag on device
 * Returns : struct scsi_cmnd if successful, or NULL if no command satisfies requirements
 */
extern struct scsi_cmnd *queue_remove_tgtluntag(Queue_t *queue, int target,
						int lun, int tag);

/*
 * Function: queue_remove_all_target(queue, target)
 * Purpose : remove all SCSI commands from the queue for a specified target
 * Params  : queue  - queue to remove command from
 *           target - target device id
 * Returns : nothing
 */
extern void queue_remove_all_target(Queue_t *queue, int target);

/*
 * Function: int queue_probetgtlun (queue, target, lun)
 * Purpose : check to see if we have a command in the queue for the specified
 *	     target/lun.
 * Params  : queue  - queue to look in
 *	     target - target we want to probe
 *	     lun    - lun on target
 * Returns : 0 if not found, != 0 if found
 */
extern int queue_probetgtlun (Queue_t *queue, int target, int lun);

/*
 * Function: int queue_remove_cmd (Queue_t *queue, struct scsi_cmnd *SCpnt)
 * Purpose : remove a specific command from the queues
 * Params  : queue - queue to look in
 *	     SCpnt - command to find
 * Returns : 0 if not found
 */
int queue_remove_cmd(Queue_t *queue, struct scsi_cmnd *SCpnt);

#endif /* QUEUE_H */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* linux/drivers/acorn/scsi/queue.h: queue handling
	3	*
	4	* Copyright (C) 1997 Russell King
	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 version 2 as
	8	* published by the Free Software Foundation.
	9	*/
	10	#ifndef QUEUE_H
	11	#define QUEUE_H
	12
	13	typedef struct {
	14	struct list_head head;
	15	struct list_head free;
	16	spinlock_t queue_lock;
	17	void alloc; / start of allocated mem */
	18	} Queue_t;
	19
	20	/*
	21	* Function: void queue_initialise (Queue_t *queue)
	22	* Purpose : initialise a queue
	23	* Params : queue - queue to initialise
	24	*/
	25	extern int queue_initialise (Queue_t *queue);
	26
	27	/*
	28	* Function: void queue_free (Queue_t *queue)
	29	* Purpose : free a queue
	30	* Params : queue - queue to free
	31	*/
	32	extern void queue_free (Queue_t *queue);
	33
	34	/*
ee0ca6ba	35	* Function: struct scsi_cmnd *queue_remove (queue)
1da177e4 LT	36	* Purpose : removes first SCSI command from a queue
1da177e4 LT	37	* Params : queue - queue to remove command from
ee0ca6ba	38	* Returns : struct scsi_cmnd if successful (and a reference), or NULL if no command available
1da177e4	39	*/
ee0ca6ba	40	extern struct scsi_cmnd queue_remove (Queue_t queue);
1da177e4 LT	41
1da177e4 LT	42	/*
ee0ca6ba	43	* Function: struct scsi_cmnd *queue_remove_exclude_ref (queue, exclude)
1da177e4 LT	44	* Purpose : remove a SCSI command from a queue
	45	* Params : queue - queue to remove command from
	46	* exclude - array of busy LUNs
ee0ca6ba	47	* Returns : struct scsi_cmnd if successful (and a reference), or NULL if no command available
1da177e4	48	*/
ee0ca6ba HK	49	extern struct scsi_cmnd queue_remove_exclude(Queue_t queue,
ee0ca6ba HK	50	unsigned long *exclude);
1da177e4 LT	51
	52	#define queue_add_cmd_ordered(queue,SCpnt) \
	53	__queue_add(queue,SCpnt,(SCpnt)->cmnd[0] == REQUEST_SENSE)
	54	#define queue_add_cmd_tail(queue,SCpnt) \
	55	__queue_add(queue,SCpnt,0)
	56	/*
ee0ca6ba	57	* Function: int __queue_add(Queue_t queue, struct scsi_cmnd SCpnt, int head)
1da177e4 LT	58	* Purpose : Add a new command onto a queue
	59	* Params : queue - destination queue
	60	* SCpnt - command to add
	61	* head - add command to head of queue
	62	* Returns : 0 on error, !0 on success
	63	*/
ee0ca6ba	64	extern int __queue_add(Queue_t queue, struct scsi_cmnd SCpnt, int head);
1da177e4 LT	65
1da177e4 LT	66	/*
ee0ca6ba	67	* Function: struct scsi_cmnd *queue_remove_tgtluntag (queue, target, lun, tag)
1da177e4 LT	68	* Purpose : remove a SCSI command from the queue for a specified target/lun/tag
	69	* Params : queue - queue to remove command from
	70	* target - target that we want
	71	* lun - lun on device
	72	* tag - tag on device
ee0ca6ba	73	* Returns : struct scsi_cmnd if successful, or NULL if no command satisfies requirements
1da177e4	74	*/
ee0ca6ba HK	75	extern struct scsi_cmnd queue_remove_tgtluntag(Queue_t queue, int target,
ee0ca6ba HK	76	int lun, int tag);
1da177e4 LT	77
	78	/*
	79	* Function: queue_remove_all_target(queue, target)
	80	* Purpose : remove all SCSI commands from the queue for a specified target
	81	* Params : queue - queue to remove command from
	82	* target - target device id
	83	* Returns : nothing
	84	*/
	85	extern void queue_remove_all_target(Queue_t *queue, int target);
	86
	87	/*
	88	* Function: int queue_probetgtlun (queue, target, lun)
	89	* Purpose : check to see if we have a command in the queue for the specified
	90	* target/lun.
	91	* Params : queue - queue to look in
	92	* target - target we want to probe
	93	* lun - lun on target
	94	* Returns : 0 if not found, != 0 if found
	95	*/
	96	extern int queue_probetgtlun (Queue_t *queue, int target, int lun);
	97
	98	/*
ee0ca6ba	99	* Function: int queue_remove_cmd (Queue_t queue, struct scsi_cmnd SCpnt)
1da177e4 LT	100	* Purpose : remove a specific command from the queues
	101	* Params : queue - queue to look in
	102	* SCpnt - command to find
	103	* Returns : 0 if not found
	104	*/
ee0ca6ba	105	int queue_remove_cmd(Queue_t queue, struct scsi_cmnd SCpnt);
1da177e4 LT	106
1da177e4 LT	107	#endif /* QUEUE_H */