summaryrefslogtreecommitdiffstats
path: root/sys/dev/advansys/advlib.h
blob: ac7da33d5c7ee553a6181e865c8bbb6ee1534091 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
/*-
 * Definitions for low level routines and data structures
 * for the Advanced Systems Inc. SCSI controllers chips.
 *
 * Copyright (c) 1996-1997, 1999-2000 Justin T. Gibbs.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions, and the following disclaimer,
 *    without modification, immediately at the beginning of the file.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * $FreeBSD$
 */
/*-
 * Ported from:
 * advansys.c - Linux Host Driver for AdvanSys SCSI Adapters
 *     
 * Copyright (c) 1995-1996 Advanced System Products, Inc.
 * All Rights Reserved.
 *   
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that redistributions of source
 * code retain the above copyright notice and this comment without
 * modification.
 */

#ifndef _ADVLIB_H_
#define _ADVLIB_H_

#include <sys/queue.h>

struct cam_path;
union ccb;

typedef u_int8_t target_bit_vector;
#define	TARGET_BIT_VECTOR_SET -1
#define ADV_SCSI_ID_BITS	3
#define ADV_MAX_TID		7
#define ADV_MAX_LUN		7

/* Enumeration of board types */
typedef enum {
	ADV_NONE	= 0x000,
	ADV_ISA		= 0x001,
	ADV_ISAPNP	= 0x003,
	ADV_VL		= 0x004,
	ADV_EISA	= 0x008,
	ADV_PCI		= 0x010,
	ADV_MCA		= 0x020,
	ADV_PCMCIA	= 0x040,
	ADV_ULTRA	= 0x100,
	ADV_WIDE	= 0x200,
	ADV_WIDE32	= 0x400
} adv_btype;

typedef enum {
	ADV_STATE_NONE			= 0x00,
	ADV_RESOURCE_SHORTAGE		= 0x01,
	ADV_IN_TIMEOUT			= 0x02,
	ADV_BUSDMA_BLOCK		= 0x04,
	ADV_BUSDMA_BLOCK_CLEARED	= 0x08
	
} adv_state;

typedef enum {
	ACCB_FREE		= 0x00,
	ACCB_ACTIVE		= 0x01,
	ACCB_ABORT_QUEUED	= 0x02,
	ACCB_RECOVERY_CCB	= 0x04
} adv_ccb_state;

struct adv_ccb_info {
	adv_ccb_state	state;
	bus_dmamap_t	dmamap;
	union ccb*	ccb;
	SLIST_ENTRY(adv_ccb_info) links;
};

#define ccb_cinfo_ptr spriv_ptr0

#define ADV_SYN_XFER_NO			8
#define ADV_SYN_MAX_OFFSET		0x0F
#define ADV_DEF_SDTR_OFFSET		0x0F
#define ADV_DEF_SDTR_INDEX		0x00
#define ADV_OVERRUN_BSIZE		0x00000040
#define ADV_MAX_CDB_LEN			12
#define ADV_MAX_SENSE_LEN		32
#define ADV_MIN_SENSE_LEN		14

#define ADV_TIDLUN_TO_IX(tid, lun) ((tid) | ((lun) << ADV_SCSI_ID_BITS) )
#define ADV_TID_TO_TARGET_MASK(tid)  (0x01 << (tid))
#define ADV_TIX_TO_TARGET_MASK(tix)  (0x01 << ((tix) & ADV_MAX_TID))
#define ADV_TIX_TO_TID(tix)  ((tix) & ADV_MAX_TID)
#define ADV_TID_TO_TIX(tid)  ((tid) & ADV_MAX_TID)
#define ADV_TIX_TO_LUN(tix)  (((tix) >> ADV_SCSI_ID_BITS) & ADV_MAX_LUN )


/*
 * XXX
 * PnP port addresses
 * I believe that these are standard PnP address and should be replaced
 * by the values in a central ISA PnP header file when we get one.
 */
#define ADV_ISA_PNP_PORT_ADDR  (0x279)
#define ADV_ISA_PNP_PORT_WRITE (ADV_ISA_PNP_PORT_ADDR+0x800)

/*
 * Board Signatures
 */
#define ADV_SIGNATURE_WORD			0x0000
#define		 ADV_1000_ID0W			0x04C1
#define		 ADV_1000_ID0W_FIX		0x00C1

#define	ADV_SIGNATURE_BYTE			0x0001
#define		 ADV_1000_ID1B			0x25	

#define	ADV_REG_IH				0x0002
#define		ADV_INS_HALTINT			0x6281
#define		ADV_INS_HALT			0x6280
#define		ADV_INS_SINT			0x6200
#define		ADV_INS_RFLAG_WTM		0x7380

#define ADV_CONFIG_LSW				0x0002
#define		ADV_CFG_LSW_ISA_DMA_CHANNEL	0x0003
#define		ADV_CFG_LSW_HOST_INT_ON		0x0020
#define		ADV_CFG_LSW_BIOS_ON		0x0040
#define		ADV_CFG_LSW_VERA_BURST_ON	0x0080
#define		ADV_CFG_LSW_SCSI_PARITY_ON	0x0800
#define		ADV_CFG_LSW_SCSIID		0x0700
#define		ADV_CFG_LSW_SCSIID_SHIFT	8
#define	ADV_CONFIG_SCSIID(cfg) ((cfg >> ADV_CFG_LSW_SCSIID_SHIFT) & ADV_MAX_TID)
	
/*
 * Chip Revision Number
 */
#define	ADV_NONEISA_CHIP_REVISION		0x0003
#define		ADV_CHIP_MIN_VER_VL	 	0x01
#define		ADV_CHIP_MAX_VER_VL	 	0x07
#define		ADV_CHIP_MIN_VER_PCI	 	0x09
#define		ADV_CHIP_MAX_VER_PCI	 	0x0F
#define		ADV_CHIP_VER_PCI_BIT	  	0x08
#define		ADV_CHIP_VER_PCI_ULTRA_3150  (ADV_CHIP_VER_PCI_BIT | 0x02)
#define		ADV_CHIP_VER_PCI_ULTRA_3050  (ADV_CHIP_VER_PCI_BIT | 0x03)
#define		ADV_CHIP_MIN_VER_ISA		0x11
#define		ADV_CHIP_MIN_VER_ISA_PNP	0x21
#define		ADV_CHIP_MAX_VER_ISA     	0x27
#define		ADV_CHIP_VER_ISA_BIT     	0x30
#define		ADV_CHIP_VER_ISAPNP_BIT  	0x20
#define		ADV_CHIP_VER_ASYN_BUG	 	0x21
#define		ADV_CHIP_MIN_VER_EISA 	 	0x41
#define		ADV_CHIP_MAX_VER_EISA	 	0x47
#define		ADV_CHIP_VER_EISA_BIT		0x40

#define ADV_CONFIG_MSW				0x0004
#define		ADV_CFG_MSW_SCSI_TARGET_ON	0x0080
#define		ADV_CFG_MSW_LRAM_8BITS_ON	0x0800
#define		ADV_CFG_MSW_CLR_MASK		0x30C0

#define	ADV_EEPROM_DATA				0x0006

#define ADV_EEPROM_CMD				0x0007
#define		ADV_EEPROM_CMD_READ		0x80
#define		ADV_EEPROM_CMD_WRITE		0x40
#define		ADV_EEPROM_CMD_WRITE_ENABLE	0x30
#define		ADV_EEPROM_CMD_WRITE_DISABLE	0x00

#define	ADV_DMA_SPEED				0x0007
#define		ADV_DEF_ISA_DMA_SPEED		4
#define	ADV_REG_FLAG				0x0007

#define	ADV_LRAM_DATA				0x0008

#define	ADV_LRAM_ADDR				0x000A

#define ADV_SYN_OFFSET				0x000B

#define	ADV_REG_PROG_COUNTER			0x000C
#define		ADV_MCODE_START_ADDR		0x0080

#define	ADV_REG_IFC				0x000D
#define		ADV_IFC_REG_LOCK		0x00
#define		ADV_IFC_REG_UNLOCK		0x09
#define		ADV_IFC_WR_EN_FILTER		0x10
#define		ADV_IFC_RD_NO_EEPROM		0x10
#define		ADV_IFC_SLEW_RATE		0x20
#define		ADV_IFC_ACT_NEG			0x40
#define		ADV_IFC_INP_FILTER		0x80
#define		ADV_IFC_INIT_DEFAULT  (ADV_IFC_ACT_NEG | ADV_IFC_REG_UNLOCK)
	
#define ADV_CHIP_STATUS				0x000E
#define 	ADV_CSW_TEST1			0x8000
#define 	ADV_CSW_AUTO_CONFIG		0x4000
#define 	ADV_CSW_RESERVED1		0x2000
#define 	ADV_CSW_IRQ_WRITTEN		0x1000
#define 	ADV_CSW_33MHZ_SELECTED		0x0800
#define 	ADV_CSW_TEST2			0x0400
#define 	ADV_CSW_TEST3			0x0200
#define 	ADV_CSW_RESERVED2		0x0100
#define 	ADV_CSW_DMA_DONE		0x0080
#define		ADV_CSW_FIFO_RDY		0x0040
#define 	ADV_CSW_EEP_READ_DONE		0x0020
#define		ADV_CSW_HALTED			0x0010
#define		ADV_CSW_SCSI_RESET_ACTIVE	0x0008
#define		ADV_CSW_PARITY_ERR		0x0004
#define		ADV_CSW_SCSI_RESET_LATCH	0x0002
#define		ADV_CSW_INT_PENDING		0x0001
/*
 * XXX I don't understand the relevence of the naming
 * convention change here.  What does CIW stand for?
 * Perhaps this is to differentiate read and write
 * values?
 */
#define		ADV_CIW_INT_ACK			0x0100
#define		ADV_CIW_TEST1			0x0200
#define		ADV_CIW_TEST2			0x0400
#define		ADV_CIW_SEL_33MHZ		0x0800
#define		ADV_CIW_IRQ_ACT			0x1000
#define		ADV_CIW_CLR_SCSI_RESET_INT	0x1000	

#define	ADV_CHIP_CTRL				0x000F
#define		ADV_CC_CHIP_RESET		0x80
#define		ADV_CC_SCSI_RESET		0x40
#define		ADV_CC_HALT			0x20
#define		ADV_CC_SINGLE_STEP		0x10
#define		ADV_CC_DMA_ENABLE		0x08
#define		ADV_CC_TEST			0x04
#define		ADV_CC_BANK_ONE			0x02	
#define		ADV_CC_DIAG			0x01
	
#define ADV_HALTCODE_W				0x0040
#define ADV_STOP_CODE_B				0x0034
#define		ADV_STOP_REQ_RISC_STOP		0x01
#define		ADV_STOP_ACK_RISC_STOP		0x03
#define		ADV_STOP_CLEAN_UP_BUSY_Q	0x10
#define		ADV_STOP_CLEAN_UP_DISC_Q	0x20
#define		ADV_STOP_HOST_REQ_RISC_HALT	0x40

/*
 * EEPROM routine constants
 * XXX What about wide controllers?
 * Surely they have space for 8 more targets.
 */	
#define	ADV_EEPROM_CFG_BEG_VL		2
#define	ADV_EEPROM_MAX_ADDR_VL		15
#define	ADV_EEPROM_CFG_BEG		32
#define	ADV_EEPROM_MAX_ADDR		45
#define	ADV_EEPROM_MAX_RETRY		20
	
struct adv_eeprom_config {
	u_int16_t	cfg_lsw;
	
	u_int16_t	cfg_msw;

	u_int8_t	init_sdtr;
	u_int8_t	disc_enable;

	u_int8_t	use_cmd_qng;
	u_int8_t        start_motor;
	
	u_int8_t	max_total_qng;
	u_int8_t	max_tag_qng;
	
	u_int8_t	bios_scan;
	u_int8_t	power_up_wait;

	u_int8_t	no_scam;
	u_int8_t        scsi_id_dma_speed;
#define		EEPROM_SCSI_ID_MASK	0x0F
#define		EEPROM_DMA_SPEED_MASK	0xF0
#define		EEPROM_DMA_SPEED(ep)				\
		(((ep).scsi_id_dma_speed & EEPROM_DMA_SPEED_MASK) >> 4)
#define		EEPROM_SET_DMA_SPEED(ep, speed)			\
		(ep).scsi_id_dma_speed &= ~EEPROM_DMA_SPEED_MASK;	\
		(ep).scsi_id_dma_speed |=				\
		    (((speed) << 4) & EEPROM_DMA_SPEED_MASK)
#define		EEPROM_SCSIID(ep) ((ep).scsi_id_dma_speed & EEPROM_SCSI_ID_MASK)
#define		EEPROM_SET_SCSIID(ep, id)			\
		(ep).scsi_id_dma_speed &= ~EEPROM_SCSI_ID_MASK; \
		(ep).scsi_id_dma_speed |= ((id) & EEPROM_SCSI_ID_MASK)
	u_int8_t	sdtr_data[8];
	u_int8_t	adapter_info[6];

	u_int16_t	cntl;

	u_int16_t	chksum;
};

/* Bank 1 */
#define	ADV_SEQ_ACCUM				0x0000
#define	ADV_QUEUE_ELEMENT_INDEX			0x0001
#define	ADV_SEQ_INSTRUCTION_HOLD		0x0002
#define	ADV_QUEUE_ELEMENT_POINTER		0x0003
#define	ADV_HOST_DATA_FIFO_L			0x0004
#define ADV_HOST_SCSIID				0x0005
#define	ADV_HOST_DATA_FIFO_H			0x0006
#define ADV_SCSI_CONTROL			0x0009
#define		SC_SEL				0x80
#define		SC_BSY				0x40
#define		SC_ACK				0x20
#define		SC_REQ				0x10
#define		SC_ATN				0x08
#define		SC_IO				0x04
#define		SC_CD				0x02
#define		SC_MSG				0x01
#define	ADV_SCSIDATL				0x000B
#define	ADV_DMA_TRANSFER_CNT			0x000C
#define	ADV_DMA_TRANSFER_CNT1			0x000E

/*
 * Instruction data and code segment addresses,
 * and transaction address translation (queues).
 * All addresses refer to on board LRAM.
 */
#define ADV_DATA_SEC_BEG		0x0080
#define ADV_DATA_SEC_END		0x0080
#define ADV_CODE_SEC_BEG		0x0080
#define ADV_CODE_SEC_END		0x0080
#define ADV_QADR_BEG			0x4000
#define ADV_QADR_END			0x7FFF
#define ADV_QLAST_ADR			0x7FC0
#define ADV_QBLK_SIZE			0x40
#define ADV_BIOS_DATA_QBEG		0xF8
#define ADV_MAX_QNO			0xF8
#define ADV_QADR_USED (ADV_MAX_QNO * 64)
#define ADV_QNO_TO_QADDR(q_no) ((ADV_QADR_BEG) + ((u_int16_t)(q_no) << 6))

#define ADV_MIN_ACTIVE_QNO		0x01
#define ADV_QLINK_END			0xFF

#define ADV_MAX_SG_QUEUE		5
#define ADV_SG_LIST_PER_Q		7
#define ADV_MAX_SG_LIST			(1 + ((ADV_SG_LIST_PER_Q) * (ADV_MAX_SG_QUEUE)))

#define ADV_MIN_REMAIN_Q		0x02
#define ADV_DEF_MAX_TOTAL_QNG		0xF0
#define ADV_MIN_TAG_Q_PER_DVC		0x04
#define ADV_DEF_TAG_Q_PER_DVC		0x04
#define ADV_MIN_FREE_Q			ADV_MIN_REMAIN_Q
#define ADV_MIN_TOTAL_QNG		((ADV_MAX_SG_QUEUE)+(ADV_MIN_FREE_Q))
#define ADV_MAX_TOTAL_QNG		240
#define ADV_MAX_INRAM_TAG_QNG		16
#define ADV_MAX_PCI_INRAM_TOTAL_QNG	20
#define	ADV_MAX_PCI_ULTRA_INRAM_TOTAL_QNG 16
#define	ADV_MAX_PCI_ULTRA_INRAM_TAG_QNG	8

#define ADV_DEF_IRQ_NO			10
#define ADV_MAX_IRQ_NO			15
#define ADV_MIN_IRQ_NO			10

#define ADV_SCSIQ_CPY_BEG		4
#define ADV_SCSIQ_SGHD_CPY_BEG		2

/* SCSIQ Microcode representation offsets */
#define ADV_SCSIQ_B_FWD			0
#define ADV_SCSIQ_B_BWD			1
#define ADV_SCSIQ_B_STATUS		2
#define ADV_SCSIQ_B_QNO			3
#define ADV_SCSIQ_B_CNTL		4
#define ADV_SCSIQ_B_SG_QUEUE_CNT	5
#define	ADV_SCSIQ_B_LIST_CNT		6
#define	ADV_SCSIQ_B_CUR_LIST_CNT	7
#define	ADV_SCSIQ_D_DATA_ADDR		8
#define	ADV_SCSIQ_D_DATA_CNT		12
#define	ADV_SCSIQ_B_SENSE_LEN		20
#define	ADV_SCSIQ_DONE_INFO_BEG		22
#define	ADV_SCSIQ_D_CINFO_IDX		22
#define	ADV_SCSIQ_B_TARGET_IX		26
#define	ADV_SCSIQ_B_CDB_LEN		28
#define	ADV_SCSIQ_B_TAG_CODE		29
#define	ADV_SCSIQ_W_VM_ID		30
#define	ADV_SCSIQ_DONE_STATUS		32
#define	ADV_SCSIQ_HOST_STATUS		33
#define	ADV_SCSIQ_SCSI_STATUS		34
#define	ADV_SCSIQ_CDB_BEG		36
#define ADV_SCSIQ_B_FIRST_SG_QK_QP	48
#define	ADV_SCSIQ_B_SG_WK_QP		49
#define	ADV_SCSIQ_B_SG_WK_IX		50
#define	ADV_SCSIQ_W_ALT_DC1		52
#define	ADV_SCSIQ_DW_REMAIN_XFER_ADDR	56
#define	ADV_SCSIQ_DW_REMAIN_XFER_CNT	60

/* LRAM Offsets */
#define ADVV_MSGOUT_BEG			0x0000
#define ADVV_MSGOUT_SDTR_PERIOD		(ADVV_MSGOUT_BEG+3)
#define ADVV_MSGOUT_SDTR_OFFSET		(ADVV_MSGOUT_BEG+4)

#define	ADVV_BREAK_SAVED_CODE		0x0006

#define ADVV_MSGIN_BEG			(ADVV_MSGOUT_BEG+8)
#define ADVV_MSGIN_SDTR_PERIOD		(ADVV_MSGIN_BEG+3)
#define ADVV_MSGIN_SDTR_OFFSET		(ADVV_MSGIN_BEG+4)

#define ADVV_SDTR_DATA_BEG		(ADVV_MSGIN_BEG+8)
#define ADVV_SDTR_DONE_BEG		(ADVV_SDTR_DATA_BEG+8)
#define ADVV_MAX_DVC_QNG_BEG		0x0020

#define	ADVV_BREAK_ADDR			0x0028
#define	ADVV_BREAK_NOTIFY_COUNT		0x002A
#define	ADVV_BREAK_CONTROL		0x002C
#define	ADVV_BREAK_HIT_COUNT		0x002E

#define ADVV_ASCDVC_ERR_CODE_W		0x0030
#define ADVV_MCODE_CHKSUM_W		0x0032
#define ADVV_MCODE_SIZE_W		0x0034
#define ADVV_STOP_CODE_B		0x0036
#define ADVV_DVC_ERR_CODE_B		0x0037

#define ADVV_OVERRUN_PADDR_D		0x0038
#define ADVV_OVERRUN_BSIZE_D		0x003C

#define ADVV_HALTCODE_W			0x0040
#define		ADV_HALT_EXTMSG_IN			0x8000
#define		ADV_HALT_CHK_CONDITION			0x8100
#define		ADV_HALT_SS_QUEUE_FULL			0x8200
#define		ADV_HALT_DISABLE_ASYN_USE_SYN_FIX	0x8300
#define		ADV_HALT_ENABLE_ASYN_USE_SYN_FIX	0x8400
#define		ADV_HALT_SDTR_REJECTED			0x4000
#define		ADV_HALT_HOST_COPY_SG_LIST_TO_RISC	0x2000

#define ADVV_CHKSUM_W			0x0042
#define ADVV_MC_DATE_W			0x0044
#define ADVV_MC_VER_W			0x0046
#define ADVV_NEXTRDY_B			0x0048
#define ADVV_DONENEXT_B			0x0049
#define ADVV_USE_TAGGED_QNG_B		0x004A
#define ADVV_SCSIBUSY_B			0x004B
#define	ADVV_Q_DONE_IN_PROGRESS_B	0x004C
#define ADVV_CURCDB_B			0x004D
#define ADVV_RCLUN_B			0x004E
#define ADVV_BUSY_QHEAD_B		0x004F
#define ADVV_DISC1_QHEAD_B		0x0050

#define ADVV_DISC_ENABLE_B		0x0052
#define ADVV_CAN_TAGGED_QNG_B		0x0053
#define ADVV_HOSTSCSI_ID_B		0x0055
#define ADVV_MCODE_CNTL_B		0x0056
#define ADVV_NULL_TARGET_B		0x0057

#define ADVV_FREE_Q_HEAD_W		0x0058
#define ADVV_DONE_Q_TAIL_W		0x005A
#define ADVV_FREE_Q_HEAD_B		(ADVV_FREE_Q_HEAD_W+1)
#define ADVV_DONE_Q_TAIL_B		(ADVV_DONE_Q_TAIL_W+1)

#define ADVV_HOST_FLAG_B		0x005D
#define		ADV_HOST_FLAG_IN_ISR	0x01
#define		ADV_HOST_FLAG_ACK_INT	0x02


#define ADVV_TOTAL_READY_Q_B		  0x0064
#define ADVV_VER_SERIAL_B		  0x0065
#define ADVV_HALTCODE_SAVED_W		  0x0066
#define ADVV_WTM_FLAG_B			  0x0068
#define ADVV_RISC_FLAG_B		  0x006A
#define		ADV_RISC_FLAG_GEN_INT     0x01
#define		ADV_RISC_FLAG_REQ_SG_LIST 0x02

#define ADVV_REQ_SG_LIST_QP		0x006B

#define ADV_TRANS_CUR		0x01	/* Modify current neogtiation status */
#define ADV_TRANS_ACTIVE	0x03	/* Assume this is the active target */
#define ADV_TRANS_GOAL		0x04	/* Modify negotiation goal */
#define ADV_TRANS_USER		0x08	/* Modify user negotiation settings */

struct adv_transinfo {
	u_int8_t period;
	u_int8_t offset;
};

struct adv_target_transinfo {
	struct adv_transinfo current;
	struct adv_transinfo goal;
	struct adv_transinfo user;
};

struct adv_softc {
	device_t		 dev;
	bus_space_tag_t		 tag;
	bus_space_handle_t	 bsh;
	struct cam_sim		*sim;
	LIST_HEAD(, ccb_hdr)	 pending_ccbs;
	struct adv_ccb_info	*ccb_infos;
	SLIST_HEAD(, adv_ccb_info) free_ccb_infos;
	bus_dma_tag_t		 parent_dmat;
	bus_dma_tag_t		 buffer_dmat;
	bus_dma_tag_t		 sense_dmat;
	bus_dmamap_t		 sense_dmamap;
	struct scsi_sense_data	*sense_buffers;
	bus_addr_t		 sense_physbase;
	bus_addr_t		 overrun_physbase;
	adv_btype		 type;
	struct			 adv_target_transinfo tinfo[8];
	target_bit_vector	 fix_asyn_xfer;
	target_bit_vector	 fix_asyn_xfer_always;
	target_bit_vector	 disc_enable;
	target_bit_vector	 user_disc_enable;
	target_bit_vector	 cmd_qng_enabled;
	target_bit_vector	 user_cmd_qng_enabled;
	u_int16_t		 control;
#define		ADV_CNTL_INITIATOR		0x0001
#define		ADV_CNTL_BIOS_GT_1GB		0x0002
#define		ADV_CNTL_BIOS_GT_2_DISK		0x0004
#define		ADV_CNTL_BIOS_REMOVABLE		0x0008
#define		ADV_CNTL_NO_SCAM		0x0010
#define		ADV_CNTL_INT_MULTI_Q		0x0080
#define		ADV_CNTL_NO_LUN_SUPPORT		0x0040
#define		ADV_CNTL_NO_VERIFY_COPY		0x0100
#define		ADV_CNTL_RESET_SCSI		0x0200
#define		ADV_CNTL_INIT_INQUIRY		0x0400
#define		ADV_CNTL_INIT_VERBOSE		0x0800
#define		ADV_CNTL_SCSI_PARITY		0x1000
#define		ADV_CNTL_BURST_MODE		0x2000
#define		ADV_CNTL_SDTR_ENABLE_ULTRA	0x4000
	
	u_int16_t		 bug_fix_control;
#define		ADV_BUG_FIX_IF_NOT_DWB		0x0001
#define		ADV_BUG_FIX_ASYN_USE_SYN	0x0002
	
	adv_state		 state;
	struct cam_path		*path;
	int			 unit;
	int			 init_level;
	u_int32_t		 max_dma_addr;
	u_int32_t		 max_dma_count;
	u_int8_t		 isa_dma_speed;
	u_int8_t		 isa_dma_channel;
	u_int8_t		 scsi_id;
	u_int8_t		 chip_version;
	u_int8_t		 max_tags_per_target;
	u_int8_t		 max_openings;
	u_int8_t		 cur_active;
	u_int8_t		 openings_needed;
	u_int8_t		 ccb_infos_allocated;
	u_int8_t		*sdtr_period_tbl;
	u_int8_t		 sdtr_period_tbl_size;
};

/*
 * Structures for talking to the RISC engine.
 */
struct adv_scsiq_1 {
	u_int8_t		status;
#define		QS_FREE        0x00
#define		QS_READY       0x01
#define		QS_DISC1       0x02
#define		QS_DISC2       0x04
#define		QS_BUSY        0x08
#define		QS_ABORTED     0x40
#define		QS_DONE        0x80
	
	u_int8_t		q_no;		/*
						 * Queue ID of the first queue
						 * used in this transaction.
						 */
	u_int8_t		cntl;
#define		QC_NO_CALLBACK   0x01
#define		QC_SG_SWAP_QUEUE 0x02
#define		QC_SG_HEAD       0x04
#define		QC_DATA_IN       0x08
#define		QC_DATA_OUT      0x10
#define		QC_URGENT        0x20
#define		QC_MSG_OUT       0x40
#define		QC_REQ_SENSE     0x80
	
	u_int8_t		sg_queue_cnt;	/* Number of SG entries */

	u_int8_t		target_id;	/* target id as a bit vector */
	u_int8_t		target_lun;	/* LUN - taken from our xs */

	u_int32_t		data_addr;	/*
						 * physical addres of first
						 * (possibly only) segment
						 * to transfer.
						 */
	u_int32_t		data_cnt;	/*
						 * byte count of the first
						 * (possibly only) segment
						 * to transfer.
						 */
	u_int32_t		sense_addr;	/*
						 * physical address of the sense
						 * buffer.
						 */
	u_int8_t		sense_len;	/* length of sense buffer */
	u_int8_t		extra_bytes;
};

struct adv_scsiq_2 {
	u_int32_t		ccb_index;	/* Index to our CCB Info */
	u_int8_t		target_ix;      /* Combined TID and LUN */

	u_int8_t		flag;
	u_int8_t		cdb_len;	/*
						 * Number of bytes in the SCSI
						 * command to execute.
						 */
	u_int8_t		tag_code;	/*
						 * Tag type for this transaction
						 * (SIMPLE, ORDERED, HEAD )
						 */
#define		ADV_TAG_FLAG_EXTRA_BYTES               0x10
#define		ADV_TAG_FLAG_DISABLE_DISCONNECT        0x04
#define		ADV_TAG_FLAG_DISABLE_ASYN_USE_SYN_FIX  0x08
#define		ADV_TAG_FLAG_DISABLE_CHK_COND_INT_HOST 0x40
	
	u_int16_t		vm_id;
};

struct adv_scsiq_3 {
	u_int8_t		done_stat;
#define		QD_IN_PROGRESS			0x00
#define		QD_NO_ERROR			0x01
#define		QD_ABORTED_BY_HOST		0x02
#define		QD_WITH_ERROR			0x04
#define		QD_INVALID_REQUEST		0x80
#define		QD_INVALID_HOST_NUM		0x81
#define		QD_INVALID_DEVICE		0x82
#define		QD_ERR_INTERNAL			0xFF
	
	u_int8_t		host_stat;
#define		QHSTA_NO_ERROR			0x00
#define		QHSTA_M_SEL_TIMEOUT		0x11
#define		QHSTA_M_DATA_OVER_RUN		0x12
#define		QHSTA_M_DATA_UNDER_RUN		0x12
#define		QHSTA_M_UNEXPECTED_BUS_FREE	0x13
#define		QHSTA_M_BAD_BUS_PHASE_SEQ	0x14

#define		QHSTA_D_QDONE_SG_LIST_CORRUPTED	0x21
#define		QHSTA_D_ASC_DVC_ERROR_CODE_SET	0x22
#define		QHSTA_D_HOST_ABORT_FAILED	0x23
#define		QHSTA_D_EXE_SCSI_Q_FAILED	0x24
#define		QHSTA_D_EXE_SCSI_Q_BUSY_TIMEOUT	0x25
#define		QHSTA_D_ASPI_NO_BUF_POOL	0x26

#define		QHSTA_M_WTM_TIMEOUT		0x41
#define		QHSTA_M_BAD_CMPL_STATUS_IN	0x42
#define		QHSTA_M_NO_AUTO_REQ_SENSE	0x43
#define		QHSTA_M_AUTO_REQ_SENSE_FAIL	0x44
#define		QHSTA_M_TARGET_STATUS_BUSY	0x45
#define		QHSTA_M_BAD_TAG_CODE		0x46

#define		QHSTA_M_BAD_QUEUE_FULL_OR_BUSY	0x47
#define		QHSTA_M_HUNG_REQ_SCSI_BUS_RESET	0x48

#define		QHSTA_D_LRAM_CMP_ERROR		0x81
	
#define		QHSTA_M_MICRO_CODE_ERROR_HALT	0xA1
	
	u_int8_t		scsi_stat;
	u_int8_t		scsi_msg;
};

struct adv_scsiq_4 {
	u_int8_t		cdb[ADV_MAX_CDB_LEN];
	u_int8_t		y_first_sg_list_qp;
	u_int8_t		y_working_sg_qp;
	u_int8_t		y_working_sg_ix;
	u_int8_t		y_res;
	u_int16_t		x_req_count;
	u_int16_t		x_reconnect_rtn;
	u_int32_t		x_saved_data_addr;
	u_int32_t		x_saved_data_cnt;
};

struct adv_q_done_info {
	struct adv_scsiq_2	d2;
	struct adv_scsiq_3	d3;
	u_int8_t		q_status;
	u_int8_t		q_no;
	u_int8_t		cntl;
	u_int8_t		sense_len;
	u_int8_t		extra_bytes;
	u_int8_t		res;
	u_int32_t		remain_bytes;
};

struct adv_sg_entry {
	u_int32_t		addr;
	u_int32_t		bytes;
};

struct adv_sg_head {
	u_int16_t		entry_cnt;	/*
						 * Number of SG entries
						 * in this list
						 */

	u_int16_t		queue_cnt;	/*
						 * Number of queues required
						 * to store entry_cnt
						 * SG entries.
						 */

	u_int16_t		entry_to_copy;	/*
						 * Number of SG entries to
						 * copy to the board.
						 */
	u_int16_t		res;
	struct adv_sg_entry	*sg_list;
};

#define QCX_SORT        (0x0001)
#define QCX_COALEASE    (0x0002)

struct adv_scsi_q {
	struct adv_scsiq_1	q1;
	struct adv_scsiq_2	q2;
	u_int8_t		*cdbptr;	/*
						 * Pointer to the SCSI command
						 * to execute.
						 */

	struct adv_sg_head	*sg_head;	/*
						 * Pointer to possible SG list
						 */
};

struct adv_scsi_req_q {
	struct adv_scsiq_1	r1;
	struct adv_scsiq_2	r2;
	u_int8_t		*cdbptr;
	struct adv_sg_head	*sg_head;
	u_int8_t		*sense_ptr;
	struct adv_scsiq_3	r3;
	u_int8_t		cdb[ADV_MAX_CDB_LEN];
	u_int8_t		sense[ADV_MIN_SENSE_LEN];
};

struct adv_risc_q {
	u_int8_t		fwd;
	u_int8_t		bwd;
	struct adv_scsiq_1	i1;
	struct adv_scsiq_2	i2;
	struct adv_scsiq_3	i3;
	struct adv_scsiq_4	i4;
};

struct adv_sg_list_q {
	u_int8_t		seq_no;
	u_int8_t		q_no;
	u_int8_t		cntl;
#define		QCSG_SG_XFER_LIST  0x02
#define		QCSG_SG_XFER_MORE  0x04
#define		QCSG_SG_XFER_END   0x08
	
	u_int8_t		sg_head_qp;
	u_int8_t		sg_list_cnt;
	u_int8_t		sg_cur_list_cnt;
};
#define ADV_SGQ_B_SG_CNTL		4
#define ADV_SGQ_B_SG_HEAD_QP		5
#define ADV_SGQ_B_SG_LIST_CNT		6
#define ADV_SGQ_B_SG_CUR_LIST_CNT	7
#define ADV_SGQ_LIST_BEG		8

struct asc_risc_sg_list_q {
	u_int8_t		fwd;
	u_int8_t		bwd;
	struct adv_sg_list_q	sg;
	struct adv_sg_entry	sg_list[ADV_SG_LIST_PER_Q];
};

/* Chip Register functions */
void	  adv_set_bank(struct adv_softc *adv, u_int8_t bank);

/* LRAM routines */
u_int8_t  adv_read_lram_8(struct adv_softc *adv, u_int16_t addr);
void	  adv_write_lram_8(struct adv_softc *adv, u_int16_t addr,
			   u_int8_t value);
u_int16_t adv_read_lram_16(struct adv_softc *adv, u_int16_t addr);
void	  adv_write_lram_16(struct adv_softc *adv, u_int16_t addr,
			    u_int16_t value);

/* Intialization */
int	  adv_find_signature(bus_space_tag_t tag, bus_space_handle_t bsh);
void	  adv_lib_init(struct adv_softc *adv);

u_int16_t adv_get_eeprom_config(struct adv_softc *adv,
				struct adv_eeprom_config *eeprom_config);
int	  adv_set_eeprom_config(struct adv_softc *adv,
				struct adv_eeprom_config *eeprom_config);
int	  adv_reset_chip(struct adv_softc *adv, int reset_bus);
int	  adv_test_external_lram(struct adv_softc* adv);
int	  adv_init_lram_and_mcode(struct adv_softc *adv);
u_int8_t  adv_get_chip_irq(struct adv_softc *adv);
u_int8_t  adv_set_chip_irq(struct adv_softc *adv, u_int8_t irq_no);
void	  adv_set_chip_scsiid(struct adv_softc *adv, int new_id);

/* Queue handling and execution */
int	  adv_execute_scsi_queue(struct adv_softc *adv,
				 struct adv_scsi_q *scsiq,
				 u_int32_t datalen);
u_int8_t  adv_copy_lram_doneq(struct adv_softc *adv, u_int16_t q_addr,
			      struct adv_q_done_info *scsiq, u_int32_t max_dma_count);

/* Chip Control */
int	  adv_start_chip(struct adv_softc *adv);
void	  adv_start_execution(struct adv_softc *adv);
int	  adv_stop_execution(struct adv_softc *adv);
int	  adv_stop_chip(struct adv_softc *adv);
int	  adv_is_chip_halted(struct adv_softc *adv);

/* Interrupt processing */
void	  adv_ack_interrupt(struct adv_softc *adv);
void	  adv_isr_chip_halted(struct adv_softc *adv);

/* SDTR Conversion */
void	  adv_set_syncrate(struct adv_softc *adv, struct cam_path *path,
			   u_int target_id, u_int period, u_int offset,
			   u_int type);
void	  adv_sdtr_to_period_offset(struct adv_softc *adv,
				    u_int8_t sync_data, u_int8_t *period,
				    u_int8_t *offset, int tid);
u_int8_t  adv_period_offset_to_sdtr(struct adv_softc *adv, u_int *period,
				    u_int *offset, int tid);

/* Error recovery */
union ccb;
int	  adv_abort_ccb(struct adv_softc *adv, int target, int lun,
			union ccb *ccb, u_int32_t status, int queued_only);
int	  adv_reset_bus(struct adv_softc *adv, int initiate_reset);

/* Async event callback */
void	advasync(void *callback_arg, u_int32_t code,
		 struct cam_path *path, void *arg);

#define ADV_INB(adv, offset)			\
	bus_space_read_1((adv)->tag, (adv)->bsh, offset)
#define ADV_INW(adv, offset)			\
	bus_space_read_2((adv)->tag, (adv)->bsh, offset)
#define ADV_INSB(adv, offset, valp, count)	\
	bus_space_read_multi_1((adv)->tag, (adv)->bsh, offset, valp, count)

/* These controllers seem to have problems with PIO on some fast processors */
static __inline void ADV_INSW(struct adv_softc *, u_int, u_int16_t *, u_int);
static __inline void
ADV_INSW(struct adv_softc *adv, u_int offset, u_int16_t *valp, u_int count)
{
	while (count--)
		*valp++ = bus_space_read_2(adv->tag, adv->bsh, offset);
}

#define ADV_OUTB(adv, offset, val)		\
	bus_space_write_1((adv)->tag, (adv)->bsh, offset, val)
#define ADV_OUTW(adv, offset, val)		\
	bus_space_write_2((adv)->tag, (adv)->bsh, offset, val)

/* These controllers seem to have problems with PIO on some fast processors */
static __inline void ADV_OUTSW(struct adv_softc *, u_int, u_int16_t *, u_int);
static __inline void
ADV_OUTSW(struct adv_softc *adv, u_int offset, u_int16_t *valp, u_int count)
{
	while (count--)
		bus_space_write_2(adv->tag, adv->bsh, offset, *valp++);
}

#endif /* _ADVLIB_H_ */
OpenPOWER on IntegriCloud