xref: /freebsd/sys/dev/ppbus/ppb_1284.h (revision 95ee2897e98f5d444f26ed2334cc7c439f9c16c6)
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  */
29 #ifndef __1284_H
30 #define __1284_H
31 
32 /*
33  * IEEE1284 signals
34  */
35 
36 /* host driven signals */
37 
38 #define nHostClk	STROBE
39 #define Write		STROBE
40 
41 #define nHostBusy	AUTOFEED
42 #define nHostAck	AUTOFEED
43 #define DStrb		AUTOFEED
44 
45 #define nReveseRequest	nINIT
46 
47 #define nActive1284	SELECTIN
48 #define AStrb		SELECTIN
49 
50 /* peripheral driven signals */
51 
52 #define nDataAvail	nFAULT
53 #define nPeriphRequest	nFAULT
54 
55 #define Xflag		SELECT
56 
57 #define AckDataReq	PERROR
58 #define nAckReverse	PERROR
59 
60 #define nPtrBusy	nBUSY
61 #define nPeriphAck	nBUSY
62 #define Wait		nBUSY
63 
64 #define PtrClk		nACK
65 #define PeriphClk	nACK
66 #define Intr		nACK
67 
68 /* request mode values */
69 #define NIBBLE_1284_NORMAL	0x0
70 #define NIBBLE_1284_REQUEST_ID	0x4
71 #define BYTE_1284_NORMAL	0x1
72 #define BYTE_1284_REQUEST_ID	0x5
73 #define ECP_1284_NORMAL		0x10
74 #define ECP_1284_REQUEST_ID	0x14
75 #define ECP_1284_RLE		0x30
76 #define ECP_1284_RLE_REQUEST_ID	0x34
77 #define EPP_1284_NORMAL		0x40
78 #define EXT_LINK_1284_NORMAL	0x80
79 
80 /* ieee1284 mode options */
81 #define PPB_REQUEST_ID		0x1
82 #define PPB_USE_RLE		0x2
83 #define PPB_EXTENSIBILITY_LINK	0x4
84 
85 /* ieee1284 errors */
86 #define PPB_NO_ERROR		0
87 #define PPB_MODE_UNSUPPORTED	1	/* mode not supported by peripheral */
88 #define PPB_NOT_IEEE1284	2	/* not an IEEE1284 compliant periph. */
89 #define PPB_TIMEOUT		3	/* timeout */
90 #define PPB_INVALID_MODE	4	/* current mode is incorrect */
91 
92 /* ieee1284 host side states */
93 #define PPB_ERROR			0
94 #define PPB_FORWARD_IDLE		1
95 #define PPB_NEGOCIATION			2
96 #define PPB_SETUP			3
97 #define PPB_ECP_FORWARD_IDLE		4
98 #define PPB_FWD_TO_REVERSE		5
99 #define PPB_REVERSE_IDLE		6
100 #define PPB_REVERSE_TRANSFER		7
101 #define PPB_REVERSE_TO_FWD		8
102 #define PPB_EPP_IDLE			9
103 #define PPB_TERMINATION			10
104 
105 /* peripheral side states */
106 #define PPB_PERIPHERAL_NEGOCIATION	11
107 #define PPB_PERIPHERAL_IDLE		12
108 #define PPB_PERIPHERAL_TRANSFER		13
109 #define PPB_PERIPHERAL_TERMINATION	14
110 
111 extern int nibble_1284_inbyte(device_t, char *);
112 extern int byte_1284_inbyte(device_t, char *);
113 extern int spp_1284_read(device_t, int, char *, int, int *);
114 
115 extern int ppb_1284_negociate(device_t, int, int);
116 extern int ppb_1284_terminate(device_t);
117 extern int ppb_1284_read_id(device_t, int, char *, int, int *);
118 extern int ppb_1284_read(device_t, int, char *, int, int *);
119 extern int ppb_1284_get_state(device_t bus);
120 extern int ppb_1284_set_state(device_t bus, int state);
121 
122 extern int ppb_peripheral_terminate(device_t, int);
123 extern int ppb_peripheral_negociate(device_t, int, int);
124 extern int byte_peripheral_write(device_t, char *, int, int *);
125 
126 #endif
127