[deliverable/linux.git] / drivers / staging / rtl8712 / rtl871x_pwrctrl.c

/******************************************************************************
 * rtl871x_pwrctrl.c
 *
 * Copyright(c) 2007 - 2010 Realtek Corporation. All rights reserved.
 * Linux device driver for RTL8192SU
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of version 2 of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
 *
 * Modifications for inclusion into the Linux staging tree are
 * Copyright(c) 2010 Larry Finger. All rights reserved.
 *
 * Contact information:
 * WLAN FAE <wlanfae@realtek.com>
 * Larry Finger <Larry.Finger@lwfinger.net>
 *
 ******************************************************************************/

#define _RTL871X_PWRCTRL_C_

#include "osdep_service.h"
#include "drv_types.h"
#include "osdep_intf.h"

#define RTL8712_SDIO_LOCAL_BASE 0X10100000
#define SDIO_HCPWM (RTL8712_SDIO_LOCAL_BASE + 0x0081)

void r8712_set_rpwm(struct _adapter *padapter, u8 val8)
{
	u8	rpwm;
	struct pwrctrl_priv *pwrpriv = &padapter->pwrctrlpriv;

	if (pwrpriv->rpwm == val8) {
		if (pwrpriv->rpwm_retry == 0)
			return;
	}
	if (padapter->bDriverStopped || padapter->bSurpriseRemoved)
		return;
	rpwm = val8 | pwrpriv->tog;
	switch (val8) {
	case PS_STATE_S1:
		pwrpriv->cpwm = val8;
		break;
	case PS_STATE_S2:/* only for USB normal powersave mode use,
			  * temp mark some code.
			  */
	case PS_STATE_S3:
	case PS_STATE_S4:
		pwrpriv->cpwm = val8;
		break;
	default:
		break;
	}
	pwrpriv->rpwm_retry = 0;
	pwrpriv->rpwm = val8;
	r8712_write8(padapter, 0x1025FE58, rpwm);
	pwrpriv->tog += 0x80;
}

void r8712_set_ps_mode(struct _adapter *padapter, uint ps_mode, uint smart_ps)
{
	struct pwrctrl_priv *pwrpriv = &padapter->pwrctrlpriv;

	if (ps_mode > PM_Card_Disable)
		return;
	/* if driver is in active state, we dont need set smart_ps.*/
	if (ps_mode == PS_MODE_ACTIVE)
		smart_ps = 0;
	if ((pwrpriv->pwr_mode != ps_mode) || (pwrpriv->smart_ps != smart_ps)) {
		if (pwrpriv->pwr_mode == PS_MODE_ACTIVE)
			pwrpriv->bSleep = true;
		else
			pwrpriv->bSleep = false;
		pwrpriv->pwr_mode = ps_mode;
		pwrpriv->smart_ps = smart_ps;
		schedule_work(&pwrpriv->SetPSModeWorkItem);
	}
}

/*
 * Caller:ISR handler...
 *
 * This will be called when CPWM interrupt is up.
 *
 * using to update cpwn of drv; and drv will make a decision to up or
 * down pwr level
 */
void r8712_cpwm_int_hdl(struct _adapter *padapter,
			struct reportpwrstate_parm *preportpwrstate)
{
	struct pwrctrl_priv *pwrpriv = &(padapter->pwrctrlpriv);
	struct cmd_priv	*pcmdpriv = &(padapter->cmdpriv);

	if (pwrpriv->cpwm_tog == ((preportpwrstate->state) & 0x80))
		return;
	del_timer(&padapter->pwrctrlpriv.rpwm_check_timer);
	mutex_lock(&pwrpriv->mutex_lock);
	pwrpriv->cpwm = (preportpwrstate->state) & 0xf;
	if (pwrpriv->cpwm >= PS_STATE_S2) {
		if (pwrpriv->alives & CMD_ALIVE)
			complete(&(pcmdpriv->cmd_queue_comp));
	}
	pwrpriv->cpwm_tog = (preportpwrstate->state) & 0x80;
	mutex_unlock(&pwrpriv->mutex_lock);
}

static inline void register_task_alive(struct pwrctrl_priv *pwrctrl, uint tag)
{
		pwrctrl->alives |= tag;
}

static inline void unregister_task_alive(struct pwrctrl_priv *pwrctrl, uint tag)
{
	if (pwrctrl->alives & tag)
		pwrctrl->alives ^= tag;
}

static void _rpwm_check_handler (struct _adapter *padapter)
{
	struct pwrctrl_priv *pwrpriv = &padapter->pwrctrlpriv;

	if (padapter->bDriverStopped || padapter->bSurpriseRemoved)
		return;
	if (pwrpriv->cpwm != pwrpriv->rpwm)
		schedule_work(&pwrpriv->rpwm_workitem);
}

static void SetPSModeWorkItemCallback(struct work_struct *work)
{
	struct pwrctrl_priv *pwrpriv = container_of(work,
				       struct pwrctrl_priv, SetPSModeWorkItem);
	struct _adapter *padapter = container_of(pwrpriv,
				    struct _adapter, pwrctrlpriv);
	if (!pwrpriv->bSleep) {
		mutex_lock(&pwrpriv->mutex_lock);
		if (pwrpriv->pwr_mode == PS_MODE_ACTIVE)
			r8712_set_rpwm(padapter, PS_STATE_S4);
		mutex_lock(&pwrpriv->mutex_lock);
	}
}

static void rpwm_workitem_callback(struct work_struct *work)
{
	struct pwrctrl_priv *pwrpriv = container_of(work,
				       struct pwrctrl_priv, rpwm_workitem);
	struct _adapter *padapter = container_of(pwrpriv,
				    struct _adapter, pwrctrlpriv);
	if (pwrpriv->cpwm != pwrpriv->rpwm) {
		mutex_lock(&pwrpriv->mutex_lock);
		r8712_read8(padapter, SDIO_HCPWM);
		pwrpriv->rpwm_retry = 1;
		r8712_set_rpwm(padapter, pwrpriv->rpwm);
		mutex_unlock(&pwrpriv->mutex_lock);
	}
}

static void rpwm_check_handler (unsigned long data)
{
	struct _adapter *adapter = (struct _adapter *)data;

	_rpwm_check_handler(adapter);
}

void r8712_init_pwrctrl_priv(struct _adapter *padapter)
{
	struct pwrctrl_priv *pwrctrlpriv = &padapter->pwrctrlpriv;

	memset((unsigned char *)pwrctrlpriv, 0, sizeof(struct pwrctrl_priv));
	mutex_init(&pwrctrlpriv->mutex_lock);
	pwrctrlpriv->cpwm = PS_STATE_S4;
	pwrctrlpriv->pwr_mode = PS_MODE_ACTIVE;
	pwrctrlpriv->smart_ps = 0;
	pwrctrlpriv->tog = 0x80;
/* clear RPWM to ensure driver and fw back to initial state. */
	r8712_write8(padapter, 0x1025FE58, 0);
	INIT_WORK(&pwrctrlpriv->SetPSModeWorkItem, SetPSModeWorkItemCallback);
	INIT_WORK(&pwrctrlpriv->rpwm_workitem, rpwm_workitem_callback);
	setup_timer(&pwrctrlpriv->rpwm_check_timer, rpwm_check_handler,
		    (unsigned long)padapter);
}

/*
Caller: r8712_cmd_thread

Check if the fw_pwrstate is okay for issuing cmd.
If not (cpwm should be is less than P2 state), then the sub-routine
will raise the cpwm to be greater than or equal to P2.

Calling Context: Passive

Return Value:

_SUCCESS: r8712_cmd_thread can issue cmds to firmware afterwards.
_FAIL: r8712_cmd_thread can not do anything.
*/
sint r8712_register_cmd_alive(struct _adapter *padapter)
{
	uint res = _SUCCESS;
	struct pwrctrl_priv *pwrctrl = &padapter->pwrctrlpriv;

	mutex_lock(&pwrctrl->mutex_lock);
	register_task_alive(pwrctrl, CMD_ALIVE);
	if (pwrctrl->cpwm < PS_STATE_S2) {
		r8712_set_rpwm(padapter, PS_STATE_S3);
		res = _FAIL;
	}
	mutex_unlock(&pwrctrl->mutex_lock);
	return res;
}

/*
Caller: ISR

If ISR's txdone,
No more pkts for TX,
Then driver shall call this fun. to power down firmware again.
*/

void r8712_unregister_cmd_alive(struct _adapter *padapter)
{
	struct pwrctrl_priv *pwrctrl = &padapter->pwrctrlpriv;

	mutex_lock(&pwrctrl->mutex_lock);
	unregister_task_alive(pwrctrl, CMD_ALIVE);
	if ((pwrctrl->cpwm > PS_STATE_S2) &&
	   (pwrctrl->pwr_mode > PS_MODE_ACTIVE)) {
		if ((pwrctrl->alives == 0) &&
		    (check_fwstate(&padapter->mlmepriv,
		     _FW_UNDER_LINKING) != true)) {
			r8712_set_rpwm(padapter, PS_STATE_S0);
		}
	}
	mutex_unlock(&pwrctrl->mutex_lock);
}
Commit	Line	Data
2865d42c LF	1	/******************************************************************************
	2	* rtl871x_pwrctrl.c
	3	*
	4	* Copyright(c) 2007 - 2010 Realtek Corporation. All rights reserved.
	5	* Linux device driver for RTL8192SU
	6	*
	7	* This program is free software; you can redistribute it and/or modify it
	8	* under the terms of version 2 of the GNU General Public License as
	9	* published by the Free Software Foundation.
	10	*
	11	* This program is distributed in the hope that it will be useful, but WITHOUT
	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	14	* more details.
	15	*
	16	* You should have received a copy of the GNU General Public License along with
	17	* this program; if not, write to the Free Software Foundation, Inc.,
	18	* 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
	19	*
	20	* Modifications for inclusion into the Linux staging tree are
	21	* Copyright(c) 2010 Larry Finger. All rights reserved.
	22	*
	23	* Contact information:
	24	* WLAN FAE <wlanfae@realtek.com>
	25	* Larry Finger <Larry.Finger@lwfinger.net>
	26	*
	27	******************************************************************************/
	28
	29	#define _RTL871X_PWRCTRL_C_
	30
	31	#include "osdep_service.h"
	32	#include "drv_types.h"
	33	#include "osdep_intf.h"
	34
	35	#define RTL8712_SDIO_LOCAL_BASE 0X10100000
	36	#define SDIO_HCPWM (RTL8712_SDIO_LOCAL_BASE + 0x0081)
	37
	38	void r8712_set_rpwm(struct _adapter *padapter, u8 val8)
	39	{
	40	u8 rpwm;
	41	struct pwrctrl_priv *pwrpriv = &padapter->pwrctrlpriv;
	42
	43	if (pwrpriv->rpwm == val8) {
	44	if (pwrpriv->rpwm_retry == 0)
	45	return;
	46	}
1ca96884	47	if (padapter->bDriverStopped \|\| padapter->bSurpriseRemoved)
2865d42c LF	48	return;
	49	rpwm = val8 \| pwrpriv->tog;
	50	switch (val8) {
	51	case PS_STATE_S1:
	52	pwrpriv->cpwm = val8;
	53	break;
	54	case PS_STATE_S2:/* only for USB normal powersave mode use,
bef611a9 RB	55	* temp mark some code.
bef611a9 RB	56	*/
2865d42c LF	57	case PS_STATE_S3:
	58	case PS_STATE_S4:
	59	pwrpriv->cpwm = val8;
	60	break;
	61	default:
	62	break;
	63	}
	64	pwrpriv->rpwm_retry = 0;
	65	pwrpriv->rpwm = val8;
	66	r8712_write8(padapter, 0x1025FE58, rpwm);
	67	pwrpriv->tog += 0x80;
	68	}
	69
	70	void r8712_set_ps_mode(struct _adapter *padapter, uint ps_mode, uint smart_ps)
	71	{
	72	struct pwrctrl_priv *pwrpriv = &padapter->pwrctrlpriv;
	73
	74	if (ps_mode > PM_Card_Disable)
	75	return;
	76	/* if driver is in active state, we dont need set smart_ps.*/
	77	if (ps_mode == PS_MODE_ACTIVE)
	78	smart_ps = 0;
	79	if ((pwrpriv->pwr_mode != ps_mode) \|\| (pwrpriv->smart_ps != smart_ps)) {
	80	if (pwrpriv->pwr_mode == PS_MODE_ACTIVE)
	81	pwrpriv->bSleep = true;
	82	else
	83	pwrpriv->bSleep = false;
	84	pwrpriv->pwr_mode = ps_mode;
	85	pwrpriv->smart_ps = smart_ps;
f2355b69	86	schedule_work(&pwrpriv->SetPSModeWorkItem);
2865d42c LF	87	}
	88	}
	89
	90	/*
	91	* Caller:ISR handler...
	92	*
	93	* This will be called when CPWM interrupt is up.
	94	*
3cbeb42e	95	* using to update cpwn of drv; and drv will make a decision to up or
2865d42c LF	96	* down pwr level
	97	*/
	98	void r8712_cpwm_int_hdl(struct _adapter *padapter,
	99	struct reportpwrstate_parm *preportpwrstate)
	100	{
	101	struct pwrctrl_priv *pwrpriv = &(padapter->pwrctrlpriv);
	102	struct cmd_priv *pcmdpriv = &(padapter->cmdpriv);
2865d42c LF	103
	104	if (pwrpriv->cpwm_tog == ((preportpwrstate->state) & 0x80))
	105	return;
39a6e737	106	del_timer(&padapter->pwrctrlpriv.rpwm_check_timer);
5c2ba8b8	107	mutex_lock(&pwrpriv->mutex_lock);
2865d42c LF	108	pwrpriv->cpwm = (preportpwrstate->state) & 0xf;
	109	if (pwrpriv->cpwm >= PS_STATE_S2) {
	110	if (pwrpriv->alives & CMD_ALIVE)
0f89054a	111	complete(&(pcmdpriv->cmd_queue_comp));
2865d42c LF	112	}
2865d42c LF	113	pwrpriv->cpwm_tog = (preportpwrstate->state) & 0x80;
5c2ba8b8	114	mutex_unlock(&pwrpriv->mutex_lock);
2865d42c LF	115	}
	116
	117	static inline void register_task_alive(struct pwrctrl_priv *pwrctrl, uint tag)
	118	{
	119	pwrctrl->alives \|= tag;
	120	}
	121
	122	static inline void unregister_task_alive(struct pwrctrl_priv *pwrctrl, uint tag)
	123	{
	124	if (pwrctrl->alives & tag)
	125	pwrctrl->alives ^= tag;
	126	}
	127
	128	static void _rpwm_check_handler (struct _adapter *padapter)
	129	{
	130	struct pwrctrl_priv *pwrpriv = &padapter->pwrctrlpriv;
	131
1ca96884	132	if (padapter->bDriverStopped \|\| padapter->bSurpriseRemoved)
2865d42c LF	133	return;
2865d42c LF	134	if (pwrpriv->cpwm != pwrpriv->rpwm)
f2355b69	135	schedule_work(&pwrpriv->rpwm_workitem);
2865d42c LF	136	}
	137
	138	static void SetPSModeWorkItemCallback(struct work_struct *work)
	139	{
	140	struct pwrctrl_priv *pwrpriv = container_of(work,
	141	struct pwrctrl_priv, SetPSModeWorkItem);
	142	struct _adapter *padapter = container_of(pwrpriv,
	143	struct _adapter, pwrctrlpriv);
2865d42c	144	if (!pwrpriv->bSleep) {
5c2ba8b8	145	mutex_lock(&pwrpriv->mutex_lock);
2865d42c LF	146	if (pwrpriv->pwr_mode == PS_MODE_ACTIVE)
2865d42c LF	147	r8712_set_rpwm(padapter, PS_STATE_S4);
5c2ba8b8	148	mutex_lock(&pwrpriv->mutex_lock);
2865d42c	149	}
2865d42c LF	150	}
	151
	152	static void rpwm_workitem_callback(struct work_struct *work)
	153	{
	154	struct pwrctrl_priv *pwrpriv = container_of(work,
	155	struct pwrctrl_priv, rpwm_workitem);
	156	struct _adapter *padapter = container_of(pwrpriv,
	157	struct _adapter, pwrctrlpriv);
2865d42c	158	if (pwrpriv->cpwm != pwrpriv->rpwm) {
5c2ba8b8	159	mutex_lock(&pwrpriv->mutex_lock);
e29d3ebc	160	r8712_read8(padapter, SDIO_HCPWM);
2865d42c LF	161	pwrpriv->rpwm_retry = 1;
2865d42c LF	162	r8712_set_rpwm(padapter, pwrpriv->rpwm);
5c2ba8b8	163	mutex_unlock(&pwrpriv->mutex_lock);
2865d42c	164	}
2865d42c LF	165	}
2865d42c LF	166
e922df7d	167	static void rpwm_check_handler (unsigned long data)
2865d42c	168	{
e922df7d	169	struct _adapter adapter = (struct _adapter )data;
02a29d2d	170
2865d42c LF	171	_rpwm_check_handler(adapter);
	172	}
	173
	174	void r8712_init_pwrctrl_priv(struct _adapter *padapter)
	175	{
	176	struct pwrctrl_priv *pwrctrlpriv = &padapter->pwrctrlpriv;
	177
	178	memset((unsigned char *)pwrctrlpriv, 0, sizeof(struct pwrctrl_priv));
5c2ba8b8	179	mutex_init(&pwrctrlpriv->mutex_lock);
2865d42c LF	180	pwrctrlpriv->cpwm = PS_STATE_S4;
	181	pwrctrlpriv->pwr_mode = PS_MODE_ACTIVE;
	182	pwrctrlpriv->smart_ps = 0;
	183	pwrctrlpriv->tog = 0x80;
	184	/* clear RPWM to ensure driver and fw back to initial state. */
	185	r8712_write8(padapter, 0x1025FE58, 0);
9f952489 JS	186	INIT_WORK(&pwrctrlpriv->SetPSModeWorkItem, SetPSModeWorkItemCallback);
9f952489 JS	187	INIT_WORK(&pwrctrlpriv->rpwm_workitem, rpwm_workitem_callback);
e922df7d VT	188	setup_timer(&pwrctrlpriv->rpwm_check_timer, rpwm_check_handler,
e922df7d VT	189	(unsigned long)padapter);
2865d42c LF	190	}
	191
	192	/*
	193	Caller: r8712_cmd_thread
	194
	195	Check if the fw_pwrstate is okay for issuing cmd.
	196	If not (cpwm should be is less than P2 state), then the sub-routine
	197	will raise the cpwm to be greater than or equal to P2.
	198
	199	Calling Context: Passive
	200
	201	Return Value:
	202
	203	_SUCCESS: r8712_cmd_thread can issue cmds to firmware afterwards.
	204	_FAIL: r8712_cmd_thread can not do anything.
	205	*/
	206	sint r8712_register_cmd_alive(struct _adapter *padapter)
	207	{
	208	uint res = _SUCCESS;
	209	struct pwrctrl_priv *pwrctrl = &padapter->pwrctrlpriv;
	210
5c2ba8b8	211	mutex_lock(&pwrctrl->mutex_lock);
2865d42c LF	212	register_task_alive(pwrctrl, CMD_ALIVE);
	213	if (pwrctrl->cpwm < PS_STATE_S2) {
	214	r8712_set_rpwm(padapter, PS_STATE_S3);
	215	res = _FAIL;
	216	}
5c2ba8b8	217	mutex_unlock(&pwrctrl->mutex_lock);
2865d42c LF	218	return res;
	219	}
	220
	221	/*
	222	Caller: ISR
	223
	224	If ISR's txdone,
	225	No more pkts for TX,
	226	Then driver shall call this fun. to power down firmware again.
	227	*/
	228
	229	void r8712_unregister_cmd_alive(struct _adapter *padapter)
	230	{
	231	struct pwrctrl_priv *pwrctrl = &padapter->pwrctrlpriv;
	232
5c2ba8b8	233	mutex_lock(&pwrctrl->mutex_lock);
2865d42c LF	234	unregister_task_alive(pwrctrl, CMD_ALIVE);
	235	if ((pwrctrl->cpwm > PS_STATE_S2) &&
	236	(pwrctrl->pwr_mode > PS_MODE_ACTIVE)) {
	237	if ((pwrctrl->alives == 0) &&
	238	(check_fwstate(&padapter->mlmepriv,
	239	_FW_UNDER_LINKING) != true)) {
	240	r8712_set_rpwm(padapter, PS_STATE_S0);
	241	}
	242	}
5c2ba8b8	243	mutex_unlock(&pwrctrl->mutex_lock);
2865d42c	244	}