Staging: et131x: prune all the debug code
[safe/jmp/linux-2.6] / drivers / staging / et131x / et1310_pm.c
1 /*
2  * Agere Systems Inc.
3  * 10/100/1000 Base-T Ethernet Driver for the ET1301 and ET131x series MACs
4  *
5  * Copyright © 2005 Agere Systems Inc.
6  * All rights reserved.
7  *   http://www.agere.com
8  *
9  *------------------------------------------------------------------------------
10  *
11  * et1310_pm.c - All power management related code (not completely implemented)
12  *
13  *------------------------------------------------------------------------------
14  *
15  * SOFTWARE LICENSE
16  *
17  * This software is provided subject to the following terms and conditions,
18  * which you should read carefully before using the software.  Using this
19  * software indicates your acceptance of these terms and conditions.  If you do
20  * not agree with these terms and conditions, do not use the software.
21  *
22  * Copyright © 2005 Agere Systems Inc.
23  * All rights reserved.
24  *
25  * Redistribution and use in source or binary forms, with or without
26  * modifications, are permitted provided that the following conditions are met:
27  *
28  * . Redistributions of source code must retain the above copyright notice, this
29  *    list of conditions and the following Disclaimer as comments in the code as
30  *    well as in the documentation and/or other materials provided with the
31  *    distribution.
32  *
33  * . Redistributions in binary form must reproduce the above copyright notice,
34  *    this list of conditions and the following Disclaimer in the documentation
35  *    and/or other materials provided with the distribution.
36  *
37  * . Neither the name of Agere Systems Inc. nor the names of the contributors
38  *    may be used to endorse or promote products derived from this software
39  *    without specific prior written permission.
40  *
41  * Disclaimer
42  *
43  * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
44  * INCLUDING, BUT NOT LIMITED TO, INFRINGEMENT AND THE IMPLIED WARRANTIES OF
45  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  ANY
46  * USE, MODIFICATION OR DISTRIBUTION OF THIS SOFTWARE IS SOLELY AT THE USERS OWN
47  * RISK. IN NO EVENT SHALL AGERE SYSTEMS INC. OR CONTRIBUTORS BE LIABLE FOR ANY
48  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
49  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
50  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
51  * ON ANY THEORY OF LIABILITY, INCLUDING, BUT NOT LIMITED TO, CONTRACT, STRICT
52  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
53  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
54  * DAMAGE.
55  *
56  */
57
58 #include "et131x_version.h"
59 #include "et131x_defs.h"
60
61 #include <linux/init.h>
62 #include <linux/module.h>
63 #include <linux/types.h>
64 #include <linux/kernel.h>
65
66 #include <linux/sched.h>
67 #include <linux/ptrace.h>
68 #include <linux/slab.h>
69 #include <linux/ctype.h>
70 #include <linux/string.h>
71 #include <linux/timer.h>
72 #include <linux/interrupt.h>
73 #include <linux/in.h>
74 #include <linux/delay.h>
75 #include <linux/io.h>
76 #include <linux/bitops.h>
77 #include <asm/system.h>
78
79 #include <linux/netdevice.h>
80 #include <linux/etherdevice.h>
81 #include <linux/skbuff.h>
82 #include <linux/if_arp.h>
83 #include <linux/ioport.h>
84
85 #include "et1310_phy.h"
86 #include "et1310_pm.h"
87 #include "et1310_jagcore.h"
88 #include "et1310_mac.h"
89 #include "et1310_rx.h"
90
91 #include "et131x_adapter.h"
92 #include "et131x_initpci.h"
93
94 /**
95  * EnablePhyComa - called when network cable is unplugged
96  * @etdev: pointer to our adapter structure
97  *
98  * driver receive an phy status change interrupt while in D0 and check that
99  * phy_status is down.
100  *
101  *          -- gate off JAGCore;
102  *          -- set gigE PHY in Coma mode
103  *          -- wake on phy_interrupt; Perform software reset JAGCore,
104  *             re-initialize jagcore and gigE PHY
105  *
106  *      Add D0-ASPM-PhyLinkDown Support:
107  *          -- while in D0, when there is a phy_interrupt indicating phy link
108  *             down status, call the MPSetPhyComa routine to enter this active
109  *             state power saving mode
110  *          -- while in D0-ASPM-PhyLinkDown mode, when there is a phy_interrupt
111  *       indicating linkup status, call the MPDisablePhyComa routine to
112  *             restore JAGCore and gigE PHY
113  */
114 void EnablePhyComa(struct et131x_adapter *etdev)
115 {
116         unsigned long flags;
117         u32 GlobalPmCSR;
118
119         GlobalPmCSR = readl(&etdev->regs->global.pm_csr);
120
121         /* Save the GbE PHY speed and duplex modes. Need to restore this
122          * when cable is plugged back in
123          */
124         etdev->PoMgmt.PowerDownSpeed = etdev->AiForceSpeed;
125         etdev->PoMgmt.PowerDownDuplex = etdev->AiForceDpx;
126
127         /* Stop sending packets. */
128         spin_lock_irqsave(&etdev->SendHWLock, flags);
129         etdev->Flags |= fMP_ADAPTER_LOWER_POWER;
130         spin_unlock_irqrestore(&etdev->SendHWLock, flags);
131
132         /* Wait for outstanding Receive packets */
133
134         /* Gate off JAGCore 3 clock domains */
135         GlobalPmCSR &= ~ET_PMCSR_INIT;
136         writel(GlobalPmCSR, &etdev->regs->global.pm_csr);
137
138         /* Program gigE PHY in to Coma mode */
139         GlobalPmCSR |= ET_PM_PHY_SW_COMA;
140         writel(GlobalPmCSR, &etdev->regs->global.pm_csr);
141 }
142
143 /**
144  * DisablePhyComa - Disable the Phy Coma Mode
145  * @etdev: pointer to our adapter structure
146  */
147 void DisablePhyComa(struct et131x_adapter *etdev)
148 {
149         u32 GlobalPmCSR;
150
151         GlobalPmCSR = readl(&etdev->regs->global.pm_csr);
152
153         /* Disable phy_sw_coma register and re-enable JAGCore clocks */
154         GlobalPmCSR |= ET_PMCSR_INIT;
155         GlobalPmCSR &= ~ET_PM_PHY_SW_COMA;
156         writel(GlobalPmCSR, &etdev->regs->global.pm_csr);
157
158         /* Restore the GbE PHY speed and duplex modes;
159          * Reset JAGCore; re-configure and initialize JAGCore and gigE PHY
160          */
161         etdev->AiForceSpeed = etdev->PoMgmt.PowerDownSpeed;
162         etdev->AiForceDpx = etdev->PoMgmt.PowerDownDuplex;
163
164         /* Re-initialize the send structures */
165         et131x_init_send(etdev);
166
167         /* Reset the RFD list and re-start RU  */
168         et131x_reset_recv(etdev);
169
170         /* Bring the device back to the state it was during init prior to
171          * autonegotiation being complete.  This way, when we get the auto-neg
172          * complete interrupt, we can complete init by calling ConfigMacREGS2.
173          */
174         et131x_soft_reset(etdev);
175
176         /* setup et1310 as per the documentation ?? */
177         et131x_adapter_setup(etdev);
178
179         /* Allow Tx to restart */
180         etdev->Flags &= ~fMP_ADAPTER_LOWER_POWER;
181
182         /* Need to re-enable Rx. */
183         et131x_rx_dma_enable(etdev);
184 }
185