reset/include/reset_fsm.h

/**********************************************************************
 *
 * This file is provided under a dual license.  When you use or
 * distribute this software, you may choose to be licensed under
 * version 2 of the GNU General Public License ("GPLv2 License")
 * or BSD License.
 *
 * GPLv2 License
 *
 * Copyright(C) 2017 MediaTek Inc.
 *
 * 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 http://www.gnu.org/licenses/gpl-2.0.html for more details.
 *
 * BSD LICENSE
 *
 * Copyright(C) 2017 MediaTek Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  * Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *  * Neither the name of the copyright holder nor the names of its
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 **********************************************************************/
/*! \file   reset_fsm.h
*   \brief  reset_fsm.h
*
*
*/


/**********************************************************************
*                         C O M P I L E R   F L A G S
***********************************************************************
*/
#ifndef _RESET_FSM
#define _RESET_FSM

/**********************************************************************
*                    E X T E R N A L   R E F E R E N C E S
***********************************************************************
*/
#include <linux/kernel.h>
#include <linux/timer.h>

/**********************************************************************
*                                 M A C R O S
***********************************************************************
*/
#define MR_Info(_Fmt...)  pr_info("[reset] " _Fmt)
#define MR_Warn(_Fmt...)  pr_warn("[reset] " _Fmt)
#define MR_Err(_Fmt...) pr_err("[reset] " _Fmt)

#define RFSM_NAME_MAX_LEN 32

/**********************************************************************
*                              C O N S T A N T S
***********************************************************************
*/


/**********************************************************************
*                             D A T A   T Y P E S
***********************************************************************
*/
enum ModuleType {
	RESET_MODULE_TYPE_WIFI = 0,
	RESET_MODULE_TYPE_BT,
	RESET_MODULE_TYPE_ZB,

	RESET_MODULE_TYPE_MAX
};

enum TriggerResetApiType {
	TRIGGER_RESET_TYPE_UNSUPPORT = 0,
	TRIGGER_RESET_TYPE_GPIO_API,
	TRIGGER_RESET_TYPE_SDIO_API,
	TRIGGER_RESET_TYPE_PCIE_API,
	TRIGGER_RESET_TYPE_SPI_API,

	TRIGGER_RESET_API_TYPE_MAX
};

struct FsmState;
struct FsmEntity;
typedef void (*fsmEnterFunc)(struct FsmEntity *fsm, struct FsmState *prev);
typedef void (*fsmLeaveFunc)(struct FsmEntity *fsm, struct FsmState *next);
typedef bool (*fsmGaurdFunc)(struct FsmEntity *fsm);
typedef void (*fsmActionFunc)(struct FsmEntity *fsm);

typedef void (*ResetFunc)(void);
typedef void (*NotifyFunc)(unsigned int event, void *data);


struct ResetFsmEventAction {
	unsigned int event;
	fsmGaurdFunc guard_func;
	fsmActionFunc action_func;
	struct FsmState *nextState;
};

struct FsmState {
	char *name;
	fsmEnterFunc enter_func;
	fsmLeaveFunc leave_func;

	unsigned int eventActionListCount;
	struct ResetFsmEventAction *eventActionList;
};

struct FsmEntity {
	struct list_head node;

	char *name;
	enum ModuleType eModuleType;

	enum TriggerResetApiType resetApiType;
	bool fgReadyForReset;
	ResetFunc resetFunc;
	NotifyFunc notifyFunc;

	struct timer_list resetTimer;
	struct FsmState *fsmState;
};

/**********************************************************************
*                  F U N C T I O N   D E C L A R A T I O N S
***********************************************************************
*/
struct FsmEntity *allocFsmEntity(char *name,
				 enum ModuleType eModuleType,
				 enum TriggerResetApiType resetApiType);
void freeFsmEntity(struct FsmEntity *fsm);

void RFSM_handle_event(struct FsmEntity *fsm, unsigned int event);

/**********************************************************************
*                            P U B L I C   D A T A
***********************************************************************
*/


/**********************************************************************
*                           P R I V A T E   D A T A
***********************************************************************
*/


/**********************************************************************
*                              F U N C T I O N S
**********************************************************************/


#endif  /* _RESET_FSM */