source: SVN/cambria/redboot/packages/devs/eth/intel/npe/common/current/include/IxFeatureCtrl_sp.h @ 1

Last change on this file since 1 was 1, checked in by Tim Harvey, 2 years ago

restored latest version of files from server backup

Signed-off-by: Tim Harvey <tharvey@…>

File size: 3.8 KB
Line 
1/**
2 * @file IxFeatureCtrl_sp.h
3 *
4 * @date 26-Oct-2005
5 *
6 * @brief This file contains the semi-private API of the Feature Control component.
7 *
8 *
9 * @par
10 * IXP400 SW Release version 2.3
11 *
12 * -- Copyright Notice --
13 *
14 * @par
15 * Copyright (c) 2001-2005, Intel Corporation.
16 * All rights reserved.
17 *
18 * @par
19 * Redistribution and use in source and binary forms, with or without
20 * modification, are permitted provided that the following conditions
21 * are met:
22 * 1. Redistributions of source code must retain the above copyright
23 *    notice, this list of conditions and the following disclaimer.
24 * 2. Redistributions in binary form must reproduce the above copyright
25 *    notice, this list of conditions and the following disclaimer in the
26 *    documentation and/or other materials provided with the distribution.
27 * 3. Neither the name of the Intel Corporation nor the names of its contributors
28 *    may be used to endorse or promote products derived from this software
29 *    without specific prior written permission.
30 *
31 *
32 * @par
33 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
34 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
35 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
36 * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
37 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
38 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
39 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
40 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
41 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
42 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
43 * SUCH DAMAGE.
44 *
45 *
46 * @par
47 * -- End of Copyright Notice --
48*/
49
50/**
51 * @defgroup IxFeatureCtrlPrivateAPI Intel(R) IXP Software Feature Control (featureCtrl) Private API
52 *
53 * @brief The Semi-private API for the IXP Feature Control.
54 *
55 */
56
57 
58#ifndef IXFEATURECTRL_P_H
59#define IXFEATURECTRL_P_H
60
61/*
62 * User defined include files
63 */
64#include "IxOsal.h"
65#include "IxNpeDl.h"
66#include "IxFeatureCtrl.h"
67
68/*
69 * #defines and macros
70 */
71 
72
73/*
74 * Prototypes for interface functions
75 */
76
77/**
78 * @ingroup IxFeatureCtrlPrivateAPI
79 *
80 * @fn IxFeatureCtrlReg ixFeatureCtrlRead (void)
81 */ 
82
83
84#if defined(__ixp42X) || defined(__ixp46X)
85/* @brief This function reads out the CURRENT value of Feature Control Register.
86 *        The current value may not be the same as that of the hardware component
87 *        availability.   
88 *
89 * The bit location of each hardware component is defined above.
90 * A value of '1' in bit means the hardware component is not available.  A value of '0'   
91 * means the hardware component is available.
92 */
93#endif /* __ixp42X */
94 
95/*
96 * @return
97 *      - IxFeatureCtrlReg - the enabled/disabled status of components
98 *     
99 * @internal
100 *
101 */ 
102IxFeatureCtrlReg
103ixFeatureCtrlRead (void);
104
105/**
106 * @ingroup IxFeatureCtrlPrivateAPI
107 *
108 * @fn void ixFeatureCtrlWrite (IxFeatureCtrlReg expUnitReg)
109 */ 
110
111#if defined(__ixp42X) || defined(__ixp46X)
112/*
113 * @brief This function write the value stored in IxFeatureCtrlReg expUnitReg 
114 *        to the Feature Control Register.
115 *
116 * The bit location of each hardware component is defined above.
117 * The write is only effective on available hardware components. Writing '1' in a 
118 * bit will software disable the respective hardware component. A '0' will mean that 
119 * the hardware component will remain to be operable.
120 */
121#endif /* __ixp42X */
122
123/*
124 * @param expUnitReg @ref IxFeatureCtrlReg [in] - The value to be written to GCU Software
125 *                                                Fuse register.
126 *
127 * @return none
128 *     
129 * @internal
130 *
131 */ 
132void
133ixFeatureCtrlWrite (IxFeatureCtrlReg expUnitReg);
134
135
136#endif  /* IXFEATURECTRL_SP_H */
137 
Note: See TracBrowser for help on using the repository browser.