[deliverable/linux.git] / drivers / gpu / drm / amd / include / amd_shared.h

/*
 * Copyright 2015 Advanced Micro Devices, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 */

#ifndef __AMD_SHARED_H__
#define __AMD_SHARED_H__

#define AMD_MAX_USEC_TIMEOUT		100000  /* 100 ms */

/*
* Supported GPU families (aligned with amdgpu_drm.h)
*/
#define AMD_FAMILY_UNKNOWN              0
#define AMD_FAMILY_CI                   120 /* Bonaire, Hawaii */
#define AMD_FAMILY_KV                   125 /* Kaveri, Kabini, Mullins */
#define AMD_FAMILY_VI                   130 /* Iceland, Tonga */
#define AMD_FAMILY_CZ                   135 /* Carrizo */

/*
 * Supported ASIC types
 */
enum amd_asic_type {
	CHIP_BONAIRE = 0,
	CHIP_KAVERI,
	CHIP_KABINI,
	CHIP_HAWAII,
	CHIP_MULLINS,
	CHIP_TOPAZ,
	CHIP_TONGA,
	CHIP_CARRIZO,
	CHIP_LAST,
};

/*
 * Chip flags
 */
enum amd_chip_flags {
	AMD_ASIC_MASK = 0x0000ffffUL,
	AMD_FLAGS_MASK  = 0xffff0000UL,
	AMD_IS_MOBILITY = 0x00010000UL,
	AMD_IS_APU      = 0x00020000UL,
	AMD_IS_PX       = 0x00040000UL,
	AMD_EXP_HW_SUPPORT = 0x00080000UL,
};

enum amd_ip_block_type {
	AMD_IP_BLOCK_TYPE_COMMON,
	AMD_IP_BLOCK_TYPE_GMC,
	AMD_IP_BLOCK_TYPE_IH,
	AMD_IP_BLOCK_TYPE_SMC,
	AMD_IP_BLOCK_TYPE_DCE,
	AMD_IP_BLOCK_TYPE_GFX,
	AMD_IP_BLOCK_TYPE_SDMA,
	AMD_IP_BLOCK_TYPE_UVD,
	AMD_IP_BLOCK_TYPE_VCE,
};

enum amd_clockgating_state {
	AMD_CG_STATE_GATE = 0,
	AMD_CG_STATE_UNGATE,
};

enum amd_powergating_state {
	AMD_PG_STATE_GATE = 0,
	AMD_PG_STATE_UNGATE,
};

struct amd_ip_funcs {
	/* sets up early driver state (pre sw_init), does not configure hw - Optional */
	int (*early_init)(void *handle);
	/* sets up late driver/hw state (post hw_init) - Optional */
	int (*late_init)(void *handle);
	/* sets up driver state, does not configure hw */
	int (*sw_init)(void *handle);
	/* tears down driver state, does not configure hw */
	int (*sw_fini)(void *handle);
	/* sets up the hw state */
	int (*hw_init)(void *handle);
	/* tears down the hw state */
	int (*hw_fini)(void *handle);
	/* handles IP specific hw/sw changes for suspend */
	int (*suspend)(void *handle);
	/* handles IP specific hw/sw changes for resume */
	int (*resume)(void *handle);
	/* returns current IP block idle status */
	bool (*is_idle)(void *handle);
	/* poll for idle */
	int (*wait_for_idle)(void *handle);
	/* soft reset the IP block */
	int (*soft_reset)(void *handle);
	/* dump the IP block status registers */
	void (*print_status)(void *handle);
	/* enable/disable cg for the IP block */
	int (*set_clockgating_state)(void *handle,
				     enum amd_clockgating_state state);
	/* enable/disable pg for the IP block */
	int (*set_powergating_state)(void *handle,
				     enum amd_powergating_state state);
};

#endif /* __AMD_SHARED_H__ */
Commit	Line	Data
5fc3aeeb	1	/*
	2	* Copyright 2015 Advanced Micro Devices, Inc.
	3	*
	4	* Permission is hereby granted, free of charge, to any person obtaining a
	5	* copy of this software and associated documentation files (the "Software"),
	6	* to deal in the Software without restriction, including without limitation
	7	* the rights to use, copy, modify, merge, publish, distribute, sublicense,
	8	* and/or sell copies of the Software, and to permit persons to whom the
	9	* Software is furnished to do so, subject to the following conditions:
	10	*
	11	* The above copyright notice and this permission notice shall be included in
	12	* all copies or substantial portions of the Software.
	13	*
	14	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	15	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	16	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
	17	* THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
	18	* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
	19	* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
	20	* OTHER DEALINGS IN THE SOFTWARE.
	21	*/
	22
	23	#ifndef __AMD_SHARED_H__
	24	#define __AMD_SHARED_H__
	25
0b2daf09 JZ	26	#define AMD_MAX_USEC_TIMEOUT 100000 /* 100 ms */
	27
	28	/*
	29	* Supported GPU families (aligned with amdgpu_drm.h)
	30	*/
	31	#define AMD_FAMILY_UNKNOWN 0
	32	#define AMD_FAMILY_CI 120 /* Bonaire, Hawaii */
	33	#define AMD_FAMILY_KV 125 /* Kaveri, Kabini, Mullins */
	34	#define AMD_FAMILY_VI 130 /* Iceland, Tonga */
	35	#define AMD_FAMILY_CZ 135 /* Carrizo */
	36
2f7d10b3 JZ	37	/*
	38	* Supported ASIC types
	39	*/
	40	enum amd_asic_type {
	41	CHIP_BONAIRE = 0,
	42	CHIP_KAVERI,
	43	CHIP_KABINI,
	44	CHIP_HAWAII,
	45	CHIP_MULLINS,
	46	CHIP_TOPAZ,
	47	CHIP_TONGA,
	48	CHIP_CARRIZO,
	49	CHIP_LAST,
	50	};
	51
	52	/*
	53	* Chip flags
	54	*/
	55	enum amd_chip_flags {
	56	AMD_ASIC_MASK = 0x0000ffffUL,
	57	AMD_FLAGS_MASK = 0xffff0000UL,
	58	AMD_IS_MOBILITY = 0x00010000UL,
	59	AMD_IS_APU = 0x00020000UL,
	60	AMD_IS_PX = 0x00040000UL,
	61	AMD_EXP_HW_SUPPORT = 0x00080000UL,
	62	};
	63
5fc3aeeb	64	enum amd_ip_block_type {
	65	AMD_IP_BLOCK_TYPE_COMMON,
	66	AMD_IP_BLOCK_TYPE_GMC,
	67	AMD_IP_BLOCK_TYPE_IH,
	68	AMD_IP_BLOCK_TYPE_SMC,
	69	AMD_IP_BLOCK_TYPE_DCE,
	70	AMD_IP_BLOCK_TYPE_GFX,
	71	AMD_IP_BLOCK_TYPE_SDMA,
	72	AMD_IP_BLOCK_TYPE_UVD,
	73	AMD_IP_BLOCK_TYPE_VCE,
	74	};
	75
	76	enum amd_clockgating_state {
	77	AMD_CG_STATE_GATE = 0,
	78	AMD_CG_STATE_UNGATE,
	79	};
	80
	81	enum amd_powergating_state {
	82	AMD_PG_STATE_GATE = 0,
	83	AMD_PG_STATE_UNGATE,
	84	};
	85
	86	struct amd_ip_funcs {
	87	/* sets up early driver state (pre sw_init), does not configure hw - Optional */
	88	int (early_init)(void handle);
	89	/* sets up late driver/hw state (post hw_init) - Optional */
	90	int (late_init)(void handle);
	91	/* sets up driver state, does not configure hw */
	92	int (sw_init)(void handle);
	93	/* tears down driver state, does not configure hw */
	94	int (sw_fini)(void handle);
	95	/* sets up the hw state */
	96	int (hw_init)(void handle);
	97	/* tears down the hw state */
	98	int (hw_fini)(void handle);
	99	/* handles IP specific hw/sw changes for suspend */
	100	int (suspend)(void handle);
	101	/* handles IP specific hw/sw changes for resume */
	102	int (resume)(void handle);
	103	/* returns current IP block idle status */
	104	bool (is_idle)(void handle);
	105	/* poll for idle */
	106	int (wait_for_idle)(void handle);
	107	/* soft reset the IP block */
	108	int (soft_reset)(void handle);
	109	/* dump the IP block status registers */
	110	void (print_status)(void handle);
	111	/* enable/disable cg for the IP block */
	112	int (set_clockgating_state)(void handle,
	113	enum amd_clockgating_state state);
	114	/* enable/disable pg for the IP block */
	115	int (set_powergating_state)(void handle,
	116	enum amd_powergating_state state);
	117	};
	118
	119	#endif /* __AMD_SHARED_H__ */