2 * Copyright (c) 1998, 1999 Nicolas Souchu
3 * Copyright (c) 2001 Alcove - Nicolas Souchu
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * $FreeBSD: src/sys/dev/ppbus/immio.c,v 1.10.2.3 2001/10/02 05:27:20 nsouch Exp $
31 * Iomega ZIP+ Matchmaker Parallel Port Interface driver
33 * Thanks to David Campbell work on the Linux driver and the Iomega specs
34 * Thanks to Thiebault Moeglin for the drive
37 #include <sys/param.h>
38 #include <sys/systm.h>
39 #include <sys/module.h>
41 #include <sys/malloc.h>
47 #include <bus/ppbus/ppbio.h>
48 #include <bus/ppbus/ppbconf.h>
49 #include <bus/ppbus/ppb_msq.h>
51 #include <bus/ppbus/ppb_1284.h>
55 #define VP0_SELTMO 5000 /* select timeout */
56 #define VP0_FAST_SPINTMO 500000 /* wait status timeout */
57 #define VP0_LOW_SPINTMO 5000000 /* wait status timeout */
59 #define VP0_SECTOR_SIZE 512
62 * Microcode to execute very fast I/O sequences at the lowest bus level.
65 #define WAIT_RET MS_PARAM(7, 2, MS_TYP_PTR)
66 #define WAIT_TMO MS_PARAM(1, 0, MS_TYP_INT)
68 #define DECLARE_WAIT_MICROSEQUENCE \
69 struct ppb_microseq wait_microseq[] = { \
73 MS_BRSET(nBUSY, 4 /* ready */), \
74 MS_DBRA(-2 /* loop */), \
76 MS_RET(1), /* timed out */ \
79 MS_RFETCH(MS_REG_STR, 0xb8, MS_UNKNOWN ), \
80 MS_RET(0) /* no error */ \
83 #define SELECT_TARGET MS_PARAM(6, 1, MS_TYP_CHA)
85 #define DECLARE_SELECT_MICROSEQUENCE \
86 struct ppb_microseq select_microseq[] = { \
88 /* first, check there is nothing holding onto the bus */ \
91 MS_BRCLEAR(0x8, 2 /* _ready */), \
92 MS_DBRA(-2 /* _loop */), \
93 MS_RET(2), /* bus busy */ \
96 MS_DASS(MS_UNKNOWN /* 0x80 | 1 << target */), \
100 /* now, wait until the drive is ready */ \
101 MS_SET(VP0_SELTMO), \
103 MS_BRSET(0x8, 3 /* ready */), \
104 MS_DBRA(-2 /* loop */), \
107 MS_RET(VP0_ESELECT_TIMEOUT), \
113 static struct ppb_microseq transfer_epilog[] = {
121 #define CPP_S1 MS_PARAM(10, 2, MS_TYP_PTR)
122 #define CPP_S2 MS_PARAM(13, 2, MS_TYP_PTR)
123 #define CPP_S3 MS_PARAM(16, 2, MS_TYP_PTR)
124 #define CPP_PARAM MS_PARAM(17, 1, MS_TYP_CHA)
126 #define DECLARE_CPP_MICROSEQ \
127 struct ppb_microseq cpp_microseq[] = { \
128 MS_CASS(0x0c), MS_DELAY(2), \
129 MS_DASS(0xaa), MS_DELAY(10), \
130 MS_DASS(0x55), MS_DELAY(10), \
131 MS_DASS(0x00), MS_DELAY(10), \
132 MS_DASS(0xff), MS_DELAY(10), \
133 MS_RFETCH(MS_REG_STR, 0xb8, MS_UNKNOWN /* &s1 */), \
134 MS_DASS(0x87), MS_DELAY(10), \
135 MS_RFETCH(MS_REG_STR, 0xb8, MS_UNKNOWN /* &s2 */), \
136 MS_DASS(0x78), MS_DELAY(10), \
137 MS_RFETCH(MS_REG_STR, 0x38, MS_UNKNOWN /* &s3 */), \
138 MS_DASS(MS_UNKNOWN /* param */), \
140 MS_CASS(0x0c), MS_DELAY(10), \
141 MS_CASS(0x0d), MS_DELAY(2), \
142 MS_CASS(0x0c), MS_DELAY(10), \
143 MS_DASS(0xff), MS_DELAY(10), \
147 #define NEGOCIATED_MODE MS_PARAM(2, 1, MS_TYP_CHA)
149 #define DECLARE_NEGOCIATE_MICROSEQ \
150 struct ppb_microseq negociate_microseq[] = { \
153 MS_DASS(MS_UNKNOWN /* mode */), \
157 MS_BRSET(0x20, 5 /* continue */), \
162 MS_RET(VP0_ENEGOCIATE), \
171 #define INB_NIBBLE_L MS_PARAM(3, 2, MS_TYP_PTR)
172 #define INB_NIBBLE_H MS_PARAM(6, 2, MS_TYP_PTR)
173 #define INB_NIBBLE_F MS_PARAM(9, 0, MS_TYP_FUN)
174 #define INB_NIBBLE_P MS_PARAM(9, 1, MS_TYP_PTR)
177 * This is the sub-microseqence for MS_GET in NIBBLE mode
178 * Retrieve the two nibbles and call the C function to generate the character
179 * and store it in the buffer (see nibble_inbyte_hook())
182 #define DECLARE_NIBBLE_INBYTE_SUBMICROSEQ \
183 struct ppb_microseq nibble_inbyte_submicroseq[] = { \
188 MS_RFETCH(MS_REG_STR, MS_FETCH_ALL, MS_UNKNOWN /* low nibble */),\
191 MS_RFETCH(MS_REG_STR, MS_FETCH_ALL, MS_UNKNOWN /* high nibble */),\
194 /* do a C call to format the received nibbles */ \
195 MS_C_CALL(MS_UNKNOWN /* C hook */, MS_UNKNOWN /* param */), \
196 MS_DBRA(-7 /* loop */), \
200 static struct ppb_microseq reset_microseq[] = {
213 * nibble_inbyte_hook()
215 * Formats high and low nibble into a character
218 nibble_inbyte_hook (void *p, char *ptr)
220 struct vpo_nibble *s = (struct vpo_nibble *)p;
222 /* increment the buffer pointer */
223 *ptr = ((s->l >> 4) & 0x0f) + (s->h & 0xf0);
229 * This is the sub-microseqence for MS_GET in PS2 mode
231 static struct ppb_microseq ps2_inbyte_submicroseq[] = {
236 MS_RFETCH_P(1, MS_REG_DTR, MS_FETCH_ALL),
238 MS_DBRA(-4 /* loop */),
244 * This is the sub-microsequence for MS_PUT in both NIBBLE and PS2 modes
246 static struct ppb_microseq spp_outbyte_submicroseq[] = {
250 MS_RASSERT_P(1, MS_REG_DTR),
252 MS_DBRA(0), /* decrement counter */
253 MS_RASSERT_P(1, MS_REG_DTR),
255 MS_DBRA(-6 /* loop */),
257 /* return from the put call */
262 /* EPP 1.7 microsequences, ptr and len set at runtime */
263 static struct ppb_microseq epp17_outstr[] = {
265 MS_RASSERT_P(MS_ACCUM, MS_REG_EPP_D),
270 static struct ppb_microseq epp17_instr[] = {
272 MS_RFETCH_P(MS_ACCUM, MS_REG_EPP_D, MS_FETCH_ALL),
278 imm_disconnect(struct vpoio_data *vpo, int *connected, int release_bus)
280 DECLARE_CPP_MICROSEQ;
282 device_t ppbus = device_get_parent(vpo->vpo_dev);
286 /* all should be ok */
290 ppb_MS_init_msq(cpp_microseq, 4, CPP_S1, (void *)&s1,
291 CPP_S2, (void *)&s2, CPP_S3, (void *)&s3,
294 ppb_MS_microseq(ppbus, vpo->vpo_dev, cpp_microseq, &ret);
296 if ((s1 != (char)0xb8 || s2 != (char)0x18 || s3 != (char)0x38)) {
298 kprintf("imm%d: (disconnect) s1=0x%x s2=0x%x, s3=0x%x\n",
299 vpo->vpo_unit, s1 & 0xff, s2 & 0xff, s3 & 0xff);
301 *connected = VP0_ECONNECT;
305 return (ppb_release_bus(ppbus, vpo->vpo_dev));
311 * how : PPB_WAIT or PPB_DONTWAIT
314 imm_connect(struct vpoio_data *vpo, int how, int *disconnected, int request_bus)
316 DECLARE_CPP_MICROSEQ;
318 device_t ppbus = device_get_parent(vpo->vpo_dev);
323 /* all should be ok */
328 if ((error = ppb_request_bus(ppbus, vpo->vpo_dev, how)))
331 ppb_MS_init_msq(cpp_microseq, 3, CPP_S1, (void *)&s1,
332 CPP_S2, (void *)&s2, CPP_S3, (void *)&s3);
334 /* select device 0 in compatible mode */
335 ppb_MS_init_msq(cpp_microseq, 1, CPP_PARAM, 0xe0);
336 ppb_MS_microseq(ppbus, vpo->vpo_dev, cpp_microseq, &ret);
338 /* disconnect all devices */
339 ppb_MS_init_msq(cpp_microseq, 1, CPP_PARAM, 0x30);
340 ppb_MS_microseq(ppbus, vpo->vpo_dev, cpp_microseq, &ret);
342 if (PPB_IN_EPP_MODE(ppbus))
343 ppb_MS_init_msq(cpp_microseq, 1, CPP_PARAM, 0x28);
345 ppb_MS_init_msq(cpp_microseq, 1, CPP_PARAM, 0xe0);
347 ppb_MS_microseq(ppbus, vpo->vpo_dev, cpp_microseq, &ret);
349 if ((s1 != (char)0xb8 || s2 != (char)0x18 || s3 != (char)0x30)) {
351 kprintf("imm%d: (connect) s1=0x%x s2=0x%x, s3=0x%x\n",
352 vpo->vpo_unit, s1 & 0xff, s2 & 0xff, s3 & 0xff);
354 *disconnected = VP0_ECONNECT;
363 * Detect and initialise the VP0 adapter.
366 imm_detect(struct vpoio_data *vpo)
368 device_t ppbus = device_get_parent(vpo->vpo_dev);
371 if ((error = ppb_request_bus(ppbus, vpo->vpo_dev, PPB_DONTWAIT)))
374 /* disconnect the drive, keep the bus */
375 imm_disconnect(vpo, NULL, 0);
377 vpo->vpo_mode_found = VP0_MODE_UNDEFINED;
380 /* try to enter EPP mode since vpoio failure put the bus in NIBBLE */
381 if (ppb_set_mode(ppbus, PPB_EPP) != -1) {
382 imm_connect(vpo, PPB_DONTWAIT, &error, 0);
385 /* if connection failed try PS/2 then NIBBLE modes */
387 if (ppb_set_mode(ppbus, PPB_PS2) != -1) {
388 imm_connect(vpo, PPB_DONTWAIT, &error, 0);
391 if (ppb_set_mode(ppbus, PPB_NIBBLE) != -1) {
392 imm_connect(vpo, PPB_DONTWAIT, &error, 0);
395 vpo->vpo_mode_found = VP0_MODE_NIBBLE;
397 kprintf("imm%d: NIBBLE mode unavailable!\n", vpo->vpo_unit);
401 vpo->vpo_mode_found = VP0_MODE_PS2;
404 vpo->vpo_mode_found = VP0_MODE_EPP;
407 /* send SCSI reset signal */
408 ppb_MS_microseq(ppbus, vpo->vpo_dev, reset_microseq, NULL);
410 /* release the bus now */
411 imm_disconnect(vpo, &error, 1);
413 /* ensure we are disconnected or daisy chained peripheral
414 * may cause serious problem to the disk */
418 kprintf("imm%d: can't disconnect from the drive\n",
426 ppb_release_bus(ppbus, vpo->vpo_dev);
427 return (VP0_EINITFAILED);
434 imm_outstr(struct vpoio_data *vpo, char *_buffer, int _size)
436 union ppb_insarg buffer = { .c = _buffer };
437 union ppb_insarg size = { .i = _size };
438 union ppb_insarg unknown = { .i = MS_UNKNOWN };
439 device_t ppbus = device_get_parent(vpo->vpo_dev);
442 if (PPB_IN_EPP_MODE(ppbus))
443 ppb_reset_epp_timeout(ppbus);
445 ppb_MS_exec(ppbus, vpo->vpo_dev, MS_OP_PUT, buffer, size, unknown,
455 imm_instr(struct vpoio_data *vpo, char *_buffer, int _size)
457 union ppb_insarg buffer = { .c = _buffer };
458 union ppb_insarg size = { .i = _size };
459 union ppb_insarg unknown = { .i = MS_UNKNOWN };
460 device_t ppbus = device_get_parent(vpo->vpo_dev);
463 if (PPB_IN_EPP_MODE(ppbus))
464 ppb_reset_epp_timeout(ppbus);
466 ppb_MS_exec(ppbus, vpo->vpo_dev, MS_OP_GET, buffer, size, unknown,
473 imm_select(struct vpoio_data *vpo, int initiator, int target)
475 DECLARE_SELECT_MICROSEQUENCE;
476 device_t ppbus = device_get_parent(vpo->vpo_dev);
479 /* initialize the select microsequence */
480 ppb_MS_init_msq(select_microseq, 1,
481 SELECT_TARGET, 1 << initiator | 1 << target);
483 ppb_MS_microseq(ppbus, vpo->vpo_dev, select_microseq, &ret);
491 * H_SELIN must be low.
495 imm_wait(struct vpoio_data *vpo, int tmo)
497 DECLARE_WAIT_MICROSEQUENCE;
499 device_t ppbus = device_get_parent(vpo->vpo_dev);
503 * Return some status information.
504 * Semantics : 0x88 = ZIP+ wants more data
505 * 0x98 = ZIP+ wants to send more data
506 * 0xa8 = ZIP+ wants command
507 * 0xb8 = end of transfer, ZIP+ is sending status
510 ppb_MS_init_msq(wait_microseq, 2,
511 WAIT_RET, (void *)&ret,
514 ppb_MS_microseq(ppbus, vpo->vpo_dev, wait_microseq, &err);
517 return (0); /* command timed out */
523 imm_negociate(struct vpoio_data *vpo)
525 DECLARE_NEGOCIATE_MICROSEQ;
526 device_t ppbus = device_get_parent(vpo->vpo_dev);
530 if (PPB_IN_NIBBLE_MODE(ppbus))
532 else if (PPB_IN_PS2_MODE(ppbus))
537 #if 0 /* XXX use standalone code not to depend on ppb_1284 code yet */
538 ret = ppb_1284_negociate(ppbus, negociate_mode);
541 return (VP0_ENEGOCIATE);
544 ppb_MS_init_msq(negociate_microseq, 1,
545 NEGOCIATED_MODE, negociate_mode);
547 ppb_MS_microseq(ppbus, vpo->vpo_dev, negociate_microseq, &ret);
555 * Low level probe of vpo device
559 imm_probe(device_t dev, struct vpoio_data *vpo)
563 /* ppbus dependent initialisation */
566 /* now, try to initialise the drive */
567 if ((error = imm_detect(vpo))) {
577 * Low level attachment of vpo device
581 imm_attach(struct vpoio_data *vpo)
583 DECLARE_NIBBLE_INBYTE_SUBMICROSEQ;
584 device_t ppbus = device_get_parent(vpo->vpo_dev);
588 * Initialize microsequence code
590 vpo->vpo_nibble_inbyte_msq = kmalloc(sizeof(nibble_inbyte_submicroseq),
593 bcopy((void *)nibble_inbyte_submicroseq,
594 (void *)vpo->vpo_nibble_inbyte_msq,
595 sizeof(nibble_inbyte_submicroseq));
597 ppb_MS_init_msq(vpo->vpo_nibble_inbyte_msq, 4,
598 INB_NIBBLE_H, (void *)&(vpo)->vpo_nibble.h,
599 INB_NIBBLE_L, (void *)&(vpo)->vpo_nibble.l,
600 INB_NIBBLE_F, nibble_inbyte_hook,
601 INB_NIBBLE_P, (void *)&(vpo)->vpo_nibble);
604 * Initialize mode dependent in/out microsequences
606 if ((error = ppb_request_bus(ppbus, vpo->vpo_dev, PPB_WAIT)))
609 /* ppbus automatically restore the last mode entered during detection */
610 switch (vpo->vpo_mode_found) {
612 ppb_MS_GET_init(ppbus, vpo->vpo_dev, epp17_instr);
613 ppb_MS_PUT_init(ppbus, vpo->vpo_dev, epp17_outstr);
614 kprintf("imm%d: EPP mode\n", vpo->vpo_unit);
617 ppb_MS_GET_init(ppbus, vpo->vpo_dev, ps2_inbyte_submicroseq);
618 ppb_MS_PUT_init(ppbus, vpo->vpo_dev, spp_outbyte_submicroseq);
619 kprintf("imm%d: PS2 mode\n", vpo->vpo_unit);
621 case VP0_MODE_NIBBLE:
622 ppb_MS_GET_init(ppbus, vpo->vpo_dev, vpo->vpo_nibble_inbyte_msq);
623 ppb_MS_PUT_init(ppbus, vpo->vpo_dev, spp_outbyte_submicroseq);
624 kprintf("imm%d: NIBBLE mode\n", vpo->vpo_unit);
627 panic("imm: unknown mode %d", vpo->vpo_mode_found);
630 ppb_release_bus(ppbus, vpo->vpo_dev);
640 imm_reset_bus(struct vpoio_data *vpo)
642 device_t ppbus = device_get_parent(vpo->vpo_dev);
645 /* first, connect to the drive and request the bus */
646 imm_connect(vpo, PPB_WAIT|PPB_INTR, &disconnected, 1);
650 /* reset the SCSI bus */
651 ppb_MS_microseq(ppbus, vpo->vpo_dev, reset_microseq, NULL);
653 /* then disconnect */
654 imm_disconnect(vpo, NULL, 1);
663 * Send an SCSI command
667 imm_do_scsi(struct vpoio_data *vpo, int host, int target, char *command,
668 int clen, char *buffer, int blen, int *result, int *count,
671 device_t ppbus = device_get_parent(vpo->vpo_dev);
674 int len, error = 0, not_connected = 0;
679 * enter disk state, allocate the ppbus
682 * Should we allow this call to be interruptible?
683 * The only way to report the interruption is to return
684 * EIO to upper SCSI code :^(
686 if ((error = imm_connect(vpo, PPB_WAIT|PPB_INTR, ¬_connected, 1)))
690 *ret = VP0_ECONNECT; goto error;
694 * Select the drive ...
696 if ((*ret = imm_select(vpo,host,target)))
700 * Send the command ...
702 for (k = 0; k < clen; k+=2) {
703 if (imm_wait(vpo, VP0_FAST_SPINTMO) != (char)0xa8) {
704 *ret = VP0_ECMD_TIMEOUT;
707 if (imm_outstr(vpo, &command[k], 2)) {
708 *ret = VP0_EPPDATA_TIMEOUT;
713 if (!(r = imm_wait(vpo, VP0_LOW_SPINTMO))) {
714 *ret = VP0_ESTATUS_TIMEOUT; goto error;
717 if ((r & 0x30) == 0x10) {
718 if (imm_negociate(vpo)) {
719 *ret = VP0_ENEGOCIATE;
726 * Complete transfer ...
731 if (!(r = imm_wait(vpo, VP0_LOW_SPINTMO))) {
732 *ret = VP0_ESTATUS_TIMEOUT; goto error;
735 /* stop when the ZIP+ wants to send status */
739 if (*count >= blen) {
740 *ret = VP0_EDATA_OVERFLOW;
744 /* ZIP+ wants to send data? */
745 if (r == (char)0x88) {
746 len = (((blen - *count) >= VP0_SECTOR_SIZE)) ?
749 error = imm_outstr(vpo, &buffer[*count], len);
751 if (!PPB_IN_EPP_MODE(ppbus))
754 len = (((blen - *count) >= VP0_SECTOR_SIZE)) ?
757 error = imm_instr(vpo, &buffer[*count], len);
768 if ((PPB_IN_NIBBLE_MODE(ppbus) ||
769 PPB_IN_PS2_MODE(ppbus)) && negociated)
770 ppb_MS_microseq(ppbus, vpo->vpo_dev, transfer_epilog, NULL);
773 * Retrieve status ...
775 if (imm_negociate(vpo)) {
776 *ret = VP0_ENEGOCIATE;
781 if (imm_instr(vpo, &l, 1)) {
782 *ret = VP0_EOTHER; goto error;
785 /* check if the ZIP+ wants to send more status */
786 if (imm_wait(vpo, VP0_FAST_SPINTMO) == (char)0xb8)
787 if (imm_instr(vpo, &h, 1)) {
788 *ret = VP0_EOTHER+2; goto error;
791 /* Experience showed that we should discard this */
795 *result = ((int) h << 8) | ((int) l & 0xff);
798 if ((PPB_IN_NIBBLE_MODE(ppbus) ||
799 PPB_IN_PS2_MODE(ppbus)) && negociated)
800 ppb_MS_microseq(ppbus, vpo->vpo_dev, transfer_epilog, NULL);
802 /* return to printer state, release the ppbus */
803 imm_disconnect(vpo, NULL, 1);