xref: /freebsd/sys/dev/ppbus/ppb_1284.h (revision d91f8db5f1822c43cd256f19aae1d059e4b25a26)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 1997 Nicolas Souchu
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  * $FreeBSD$
29  *
30  */
31 #ifndef __1284_H
32 #define __1284_H
33 
34 /*
35  * IEEE1284 signals
36  */
37 
38 /* host driven signals */
39 
40 #define nHostClk	STROBE
41 #define Write		STROBE
42 
43 #define nHostBusy	AUTOFEED
44 #define nHostAck	AUTOFEED
45 #define DStrb		AUTOFEED
46 
47 #define nReveseRequest	nINIT
48 
49 #define nActive1284	SELECTIN
50 #define AStrb		SELECTIN
51 
52 /* peripheral driven signals */
53 
54 #define nDataAvail	nFAULT
55 #define nPeriphRequest	nFAULT
56 
57 #define Xflag		SELECT
58 
59 #define AckDataReq	PERROR
60 #define nAckReverse	PERROR
61 
62 #define nPtrBusy	nBUSY
63 #define nPeriphAck	nBUSY
64 #define Wait		nBUSY
65 
66 #define PtrClk		nACK
67 #define PeriphClk	nACK
68 #define Intr		nACK
69 
70 /* request mode values */
71 #define NIBBLE_1284_NORMAL	0x0
72 #define NIBBLE_1284_REQUEST_ID	0x4
73 #define BYTE_1284_NORMAL	0x1
74 #define BYTE_1284_REQUEST_ID	0x5
75 #define ECP_1284_NORMAL		0x10
76 #define ECP_1284_REQUEST_ID	0x14
77 #define ECP_1284_RLE		0x30
78 #define ECP_1284_RLE_REQUEST_ID	0x34
79 #define EPP_1284_NORMAL		0x40
80 #define EXT_LINK_1284_NORMAL	0x80
81 
82 /* ieee1284 mode options */
83 #define PPB_REQUEST_ID		0x1
84 #define PPB_USE_RLE		0x2
85 #define PPB_EXTENSIBILITY_LINK	0x4
86 
87 /* ieee1284 errors */
88 #define PPB_NO_ERROR		0
89 #define PPB_MODE_UNSUPPORTED	1	/* mode not supported by peripheral */
90 #define PPB_NOT_IEEE1284	2	/* not an IEEE1284 compliant periph. */
91 #define PPB_TIMEOUT		3	/* timeout */
92 #define PPB_INVALID_MODE	4	/* current mode is incorrect */
93 
94 /* ieee1284 host side states */
95 #define PPB_ERROR			0
96 #define PPB_FORWARD_IDLE		1
97 #define PPB_NEGOCIATION			2
98 #define PPB_SETUP			3
99 #define PPB_ECP_FORWARD_IDLE		4
100 #define PPB_FWD_TO_REVERSE		5
101 #define PPB_REVERSE_IDLE		6
102 #define PPB_REVERSE_TRANSFER		7
103 #define PPB_REVERSE_TO_FWD		8
104 #define PPB_EPP_IDLE			9
105 #define PPB_TERMINATION			10
106 
107 /* peripheral side states */
108 #define PPB_PERIPHERAL_NEGOCIATION	11
109 #define PPB_PERIPHERAL_IDLE		12
110 #define PPB_PERIPHERAL_TRANSFER		13
111 #define PPB_PERIPHERAL_TERMINATION	14
112 
113 extern int nibble_1284_inbyte(device_t, char *);
114 extern int byte_1284_inbyte(device_t, char *);
115 extern int spp_1284_read(device_t, int, char *, int, int *);
116 
117 extern int ppb_1284_negociate(device_t, int, int);
118 extern int ppb_1284_terminate(device_t);
119 extern int ppb_1284_read_id(device_t, int, char *, int, int *);
120 extern int ppb_1284_read(device_t, int, char *, int, int *);
121 extern int ppb_1284_get_state(device_t bus);
122 extern int ppb_1284_set_state(device_t bus, int state);
123 
124 extern int ppb_peripheral_terminate(device_t, int);
125 extern int ppb_peripheral_negociate(device_t, int, int);
126 extern int byte_peripheral_write(device_t, char *, int, int *);
127 
128 #endif
129