ixp425_npevar.h revision 164426
1/*-
2 * Copyright (c) 2006 Sam Leffler.  All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 * 1. Redistributions of source code must retain the above copyright
8 *    notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 *    notice, this list of conditions and the following disclaimer in the
11 *    documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
14 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
15 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
16 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
17 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
18 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
19 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
20 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
22 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23 *
24 * $FreeBSD: head/sys/arm/xscale/ixp425/ixp425_npevar.h 164426 2006-11-19 23:55:23Z sam $
25 */
26
27#ifndef _IXP425_NPEVAR_H_
28#define _IXP425_NPEVAR_H_
29
30/*
31 * Intel (R) IXP400 Software NPE Image ID Definition
32 *
33 * Firmware Id's for current firmware image.  These are typed by
34 * NPE ID and the feature set.  Not all features are available
35 * on all NPE's.
36 *
37 * HSS-0: supports 32 channelized and 4 packetized.
38 * HSS-0 + ATM + SPHY:
39 *    For HSS, 16/32 channelized and 4/0 packetized.
40 *    For ATM, AAL5, AAL0 and OAM for UTOPIA SPHY, 1 logical port, 32 VCs.
41 *    Fast Path support.
42 * HSS-0 + ATM + MPHY:
43 *    For HSS, 16/32 channelized and 4/0 packetized.
44 *    For ATM, AAL5, AAL0 and OAM for UTOPIA MPHY, 1 logical port, 32 VCs.
45 *    Fast Path support.
46 * ATM-Only:
47 *    AAL5, AAL0 and OAM for UTOPIA MPHY, 12 logical ports, 32 VCs.
48 *    Fast Path support.
49 * HSS-2:
50 *    HSS-0 and HSS-1.
51 *    Each HSS port supports 32 channelized and 4 packetized.
52 * ETH: Ethernet Rx/Tx which includes:
53 *    MAC_FILTERING, MAC_LEARNING, SPANNING_TREE, FIREWALL
54 * ETH+VLAN Ethernet Rx/Tx which includes:
55 *    MAC_FILTERING, MAC_LEARNING, SPANNING_TREE, FIREWALL, VLAN_QOS
56 * ETH+VLAN+HDR: Ethernet Rx/Tx which includes:
57 *    SPANNING_TREE, FIREWALL, VLAN_QOS, HEADER_CONVERSION
58 */
59/* XXX not right, revise */
60/* NPE A Firmware Image Id's */
61#define	NPEFW_A_HSS0		0x00010000 /* HSS-0: 32 chan+4 packet */
62#define NPEFW_A_HSS0_ATM_S_1	0x00020000 /* HSS-0+ATM UTOPIA SPHY (1 port) */
63#define NPEFW_A_HSS0_ATM_M_1	0x00020000 /* HSS-0+ATM UTOPIA MPHY (1 port) */
64#define NPEFW_A_ATM_M_12	0x00040000 /* ATM UTOPIA MPHY (12 ports) */
65#define NPEFW_A_DMA		0x00150100 /* DMA only */
66#define	NPEFW_A_HSS2		0x00090000 /* HSS-0 + HSS-1 */
67#define	NPEFW_A_ETH		0x10800200 /* Basic Ethernet */
68#define	NPEFW_A_ETH_VLAN	0x10810200 /* NPEFW_A_ETH + VLAN QoS */
69#define	NPEFW_A_ETH_VLAN_HDR	0x10820200 /* NPEFW_A_ETH_VLAN + Hdr conv */
70/* XXX ... more not included */
71
72/* NPE B Firmware Image Id's */
73#define NPEFW_B_ETH		0x01000200 /* Basic Ethernet */
74#define NPEFW_B_ETH_VLAN	0x01010200 /* NPEFW_B_ETH + VLAN QoS */
75#define NPEFW_B_ETH_VLAN_HDR	0x01020201 /* NPEFW_B_ETH_VLAN + Hdr conv */
76#define NPEFW_B_DMA		0x01020100 /* DMA only */
77/* XXX ... more not include */
78
79#define	IXP425_NPE_B_IMAGEID	0x01000200
80#define	IXP425_NPE_C_IMAGEID	0x02000200
81
82struct ixpnpe_softc;
83struct ixpnpe_softc *ixpnpe_attach(device_t);
84void	ixpnpe_detach(struct ixpnpe_softc *);
85int	ixpnpe_stopandreset(struct ixpnpe_softc *);
86int	ixpnpe_start(struct ixpnpe_softc *);
87int	ixpnpe_stop(struct ixpnpe_softc *);
88int	ixpnpe_init(struct ixpnpe_softc *,
89		const char *imageName, uint32_t imageId);
90int	ixpnpe_getfunctionality(struct ixpnpe_softc *sc);
91
92int	ixpnpe_sendmsg(struct ixpnpe_softc *, const uint32_t msg[2]);
93int	ixpnpe_recvmsg(struct ixpnpe_softc *, uint32_t msg[2]);
94int	ixpnpe_sendandrecvmsg(struct ixpnpe_softc *, const uint32_t send[2],
95		uint32_t recv[2]);
96#endif /* _IXP425_NPEVAR_H_ */
97