xref: /openbmc/linux/drivers/usb/serial/io_edgeport.h (revision 5fd54ace)
1 // SPDX-License-Identifier: GPL-2.0+
2 /************************************************************************
3  *
4  *	io_edgeport.h	Edgeport Linux Interface definitions
5  *
6  *	Copyright (C) 2000 Inside Out Networks, Inc.
7  *
8  *	This program is free software; you can redistribute it and/or modify
9  *	it under the terms of the GNU General Public License as published by
10  *	the Free Software Foundation; either version 2 of the License, or
11  *	(at your option) any later version.
12  *
13  *
14  ************************************************************************/
15 
16 #if !defined(_IO_EDGEPORT_H_)
17 #define	_IO_EDGEPORT_H_
18 
19 
20 #define MAX_RS232_PORTS		8	/* Max # of RS-232 ports per device */
21 
22 /* typedefs that the insideout headers need */
23 #ifndef LOW8
24 	#define LOW8(a)		((unsigned char)(a & 0xff))
25 #endif
26 #ifndef HIGH8
27 	#define HIGH8(a)	((unsigned char)((a & 0xff00) >> 8))
28 #endif
29 
30 #ifndef __KERNEL__
31 #define __KERNEL__
32 #endif
33 
34 #include "io_usbvend.h"
35 
36 
37 
38 /* The following table is used to map the USBx port number to
39  * the device serial number (or physical USB path), */
40 #define MAX_EDGEPORTS	64
41 
42 struct comMapper {
43 	char	SerialNumber[MAX_SERIALNUMBER_LEN+1];	/* Serial number/usb path */
44 	int	numPorts;				/* Number of ports */
45 	int	Original[MAX_RS232_PORTS];		/* Port numbers set by IOCTL */
46 	int	Port[MAX_RS232_PORTS];			/* Actual used port numbers */
47 };
48 
49 
50 #define EDGEPORT_CONFIG_DEVICE "/proc/edgeport"
51 
52 /* /proc/edgeport Interface
53  * This interface uses read/write/lseek interface to talk to the edgeport driver
54  * the following read functions are supported: */
55 #define PROC_GET_MAPPING_TO_PATH	1
56 #define PROC_GET_COM_ENTRY		2
57 #define PROC_GET_EDGE_MANUF_DESCRIPTOR	3
58 #define PROC_GET_BOOT_DESCRIPTOR	4
59 #define PROC_GET_PRODUCT_INFO		5
60 #define PROC_GET_STRINGS		6
61 #define PROC_GET_CURRENT_COM_MAPPING	7
62 
63 /* The parameters to the lseek() for the read is: */
64 #define PROC_READ_SETUP(Command, Argument)	((Command) + ((Argument)<<8))
65 
66 
67 /* the following write functions are supported: */
68 #define PROC_SET_COM_MAPPING		1
69 #define PROC_SET_COM_ENTRY		2
70 
71 
72 /* The following structure is passed to the write */
73 struct procWrite {
74 	int	Command;
75 	union {
76 		struct comMapper	Entry;
77 		int			ComMappingBasedOnUSBPort;	/* Boolean value */
78 	} u;
79 };
80 
81 /*
82  *	Product information read from the Edgeport
83  */
84 struct edgeport_product_info {
85 	__u16	ProductId;			/* Product Identifier */
86 	__u8	NumPorts;			/* Number of ports on edgeport */
87 	__u8	ProdInfoVer;			/* What version of structure is this? */
88 
89 	__u32	IsServer        :1;		/* Set if Server */
90 	__u32	IsRS232         :1;		/* Set if RS-232 ports exist */
91 	__u32	IsRS422         :1;		/* Set if RS-422 ports exist */
92 	__u32	IsRS485         :1;		/* Set if RS-485 ports exist */
93 	__u32	IsReserved      :28;		/* Reserved for later expansion */
94 
95 	__u8	RomSize;			/* Size of ROM/E2PROM in K */
96 	__u8	RamSize;			/* Size of external RAM in K */
97 	__u8	CpuRev;				/* CPU revision level (chg only if s/w visible) */
98 	__u8	BoardRev;			/* PCB revision level (chg only if s/w visible) */
99 
100 	__u8	BootMajorVersion;		/* Boot Firmware version: xx. */
101 	__u8	BootMinorVersion;		/*			  yy. */
102 	__le16	BootBuildNumber;		/*			  zzzz (LE format) */
103 
104 	__u8	FirmwareMajorVersion;		/* Operational Firmware version:xx. */
105 	__u8	FirmwareMinorVersion;		/*				yy. */
106 	__le16	FirmwareBuildNumber;		/*				zzzz (LE format) */
107 
108 	__u8	ManufactureDescDate[3];		/* MM/DD/YY when descriptor template was compiled */
109 	__u8	HardwareType;
110 
111 	__u8	iDownloadFile;			/* What to download to EPiC device */
112 	__u8	EpicVer;			/* What version of EPiC spec this device supports */
113 
114 	struct edge_compatibility_bits Epic;
115 };
116 
117 /*
118  *	Edgeport Stringblock String locations
119  */
120 #define EDGESTRING_MANUFNAME		1	/* Manufacture Name */
121 #define EDGESTRING_PRODNAME		2	/* Product Name */
122 #define EDGESTRING_SERIALNUM		3	/* Serial Number */
123 #define EDGESTRING_ASSEMNUM		4	/* Assembly Number */
124 #define EDGESTRING_OEMASSEMNUM		5	/* OEM Assembly Number */
125 #define EDGESTRING_MANUFDATE		6	/* Manufacture Date */
126 #define EDGESTRING_ORIGSERIALNUM	7	/* Serial Number */
127 
128 struct string_block {
129 	__u16	NumStrings;			/* Number of strings in block */
130 	__u16	Strings[1];			/* Start of string block */
131 };
132 
133 
134 
135 #endif
136