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

/*
 * Copyright 2014 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.
 */

/*
 * This file defines the private interface between the
 * AMD kernel graphics drivers and the AMD KFD.
 */

#ifndef KGD_KFD_INTERFACE_H_INCLUDED
#define KGD_KFD_INTERFACE_H_INCLUDED

#include <linux/types.h>

struct pci_dev;

#define KFD_INTERFACE_VERSION 1

struct kfd_dev;
struct kgd_dev;

struct kgd_mem;

enum kgd_memory_pool {
	KGD_POOL_SYSTEM_CACHEABLE = 1,
	KGD_POOL_SYSTEM_WRITECOMBINE = 2,
	KGD_POOL_FRAMEBUFFER = 3,
};

enum kgd_engine_type {
	KGD_ENGINE_PFP = 1,
	KGD_ENGINE_ME,
	KGD_ENGINE_CE,
	KGD_ENGINE_MEC1,
	KGD_ENGINE_MEC2,
	KGD_ENGINE_RLC,
	KGD_ENGINE_SDMA,
	KGD_ENGINE_MAX
};

struct kgd2kfd_shared_resources {
	/* Bit n == 1 means VMID n is available for KFD. */
	unsigned int compute_vmid_bitmap;

	/* Compute pipes are counted starting from MEC0/pipe0 as 0. */
	unsigned int first_compute_pipe;

	/* Number of MEC pipes available for KFD. */
	unsigned int compute_pipe_count;

	/* Base address of doorbell aperture. */
	phys_addr_t doorbell_physical_address;

	/* Size in bytes of doorbell aperture. */
	size_t doorbell_aperture_size;

	/* Number of bytes at start of aperture reserved for KGD. */
	size_t doorbell_start_offset;
};

/**
 * struct kgd2kfd_calls
 *
 * @exit: Notifies amdkfd that kgd module is unloaded
 *
 * @probe: Notifies amdkfd about a probe done on a device in the kgd driver.
 *
 * @device_init: Initialize the newly probed device (if it is a device that
 * amdkfd supports)
 *
 * @device_exit: Notifies amdkfd about a removal of a kgd device
 *
 * @suspend: Notifies amdkfd about a suspend action done to a kgd device
 *
 * @resume: Notifies amdkfd about a resume action done to a kgd device
 *
 * This structure contains function callback pointers so the kgd driver
 * will notify to the amdkfd about certain status changes.
 *
 */
struct kgd2kfd_calls {
	void (*exit)(void);
	struct kfd_dev* (*probe)(struct kgd_dev *kgd, struct pci_dev *pdev);
	bool (*device_init)(struct kfd_dev *kfd,
			const struct kgd2kfd_shared_resources *gpu_resources);
	void (*device_exit)(struct kfd_dev *kfd);
	void (*interrupt)(struct kfd_dev *kfd, const void *ih_ring_entry);
	void (*suspend)(struct kfd_dev *kfd);
	int (*resume)(struct kfd_dev *kfd);
};

/**
 * struct kfd2kgd_calls
 *
 * @init_sa_manager: Initialize an instance of the sa manager, used by
 * amdkfd for all system memory allocations that are mapped to the GART
 * address space
 *
 * @fini_sa_manager: Releases all memory allocations for amdkfd that are
 * handled by kgd sa manager
 *
 * @allocate_mem: Allocate a buffer from amdkfd's sa manager. The buffer can
 * be used for mqds, hpds, kernel queue, fence and runlists
 *
 * @free_mem: Frees a buffer that was allocated by amdkfd's sa manager
 *
 * @get_vmem_size: Retrieves (physical) size of VRAM
 *
 * @get_gpu_clock_counter: Retrieves GPU clock counter
 *
 * @get_max_engine_clock_in_mhz: Retrieves maximum GPU clock in MHz
 *
 * @program_sh_mem_settings: A function that should initiate the memory
 * properties such as main aperture memory type (cache / non cached) and
 * secondary aperture base address, size and memory type.
 * This function is used only for no cp scheduling mode.
 *
 * @set_pasid_vmid_mapping: Exposes pasid/vmid pair to the H/W for no cp
 * scheduling mode. Only used for no cp scheduling mode.
 *
 * @init_memory: Initializes memory apertures to fixed base/limit address
 * and non cached memory types.
 *
 * @init_pipeline: Initialized the compute pipelines.
 *
 * @hqd_load: Loads the mqd structure to a H/W hqd slot. used only for no cp
 * sceduling mode.
 *
 * @hqd_is_occupies: Checks if a hqd slot is occupied.
 *
 * @hqd_destroy: Destructs and preempts the queue assigned to that hqd slot.
 *
 * @get_fw_version: Returns FW versions from the header
 *
 * This structure contains function pointers to services that the kgd driver
 * provides to amdkfd driver.
 *
 */
struct kfd2kgd_calls {
	/* Memory management. */
	int (*init_sa_manager)(struct kgd_dev *kgd, unsigned int size);
	void (*fini_sa_manager)(struct kgd_dev *kgd);
	int (*allocate_mem)(struct kgd_dev *kgd, size_t size, size_t alignment,
			enum kgd_memory_pool pool, struct kgd_mem **mem);

	void (*free_mem)(struct kgd_dev *kgd, struct kgd_mem *mem);

	uint64_t (*get_vmem_size)(struct kgd_dev *kgd);
	uint64_t (*get_gpu_clock_counter)(struct kgd_dev *kgd);

	uint32_t (*get_max_engine_clock_in_mhz)(struct kgd_dev *kgd);

	/* Register access functions */
	void (*program_sh_mem_settings)(struct kgd_dev *kgd, uint32_t vmid,
			uint32_t sh_mem_config,	uint32_t sh_mem_ape1_base,
			uint32_t sh_mem_ape1_limit, uint32_t sh_mem_bases);

	int (*set_pasid_vmid_mapping)(struct kgd_dev *kgd, unsigned int pasid,
					unsigned int vmid);

	int (*init_memory)(struct kgd_dev *kgd);
	int (*init_pipeline)(struct kgd_dev *kgd, uint32_t pipe_id,
				uint32_t hpd_size, uint64_t hpd_gpu_addr);

	int (*hqd_load)(struct kgd_dev *kgd, void *mqd, uint32_t pipe_id,
			uint32_t queue_id, uint32_t __user *wptr);

	bool (*hqd_is_occupied)(struct kgd_dev *kgd, uint64_t queue_address,
				uint32_t pipe_id, uint32_t queue_id);

	int (*hqd_destroy)(struct kgd_dev *kgd, uint32_t reset_type,
				unsigned int timeout, uint32_t pipe_id,
				uint32_t queue_id);
	uint16_t (*get_fw_version)(struct kgd_dev *kgd,
				enum kgd_engine_type type);
};

bool kgd2kfd_init(unsigned interface_version,
		  const struct kfd2kgd_calls *f2g,
		  const struct kgd2kfd_calls **g2f);

#endif /* KGD_KFD_INTERFACE_H_INCLUDED */
Commit	Line	Data
e28740ec OG	1	/*
	2	* Copyright 2014 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	/*
	24	* This file defines the private interface between the
	25	* AMD kernel graphics drivers and the AMD KFD.
	26	*/
	27
	28	#ifndef KGD_KFD_INTERFACE_H_INCLUDED
	29	#define KGD_KFD_INTERFACE_H_INCLUDED
	30
	31	#include <linux/types.h>
	32
	33	struct pci_dev;
	34
	35	#define KFD_INTERFACE_VERSION 1
	36
	37	struct kfd_dev;
	38	struct kgd_dev;
	39
	40	struct kgd_mem;
	41
	42	enum kgd_memory_pool {
	43	KGD_POOL_SYSTEM_CACHEABLE = 1,
	44	KGD_POOL_SYSTEM_WRITECOMBINE = 2,
	45	KGD_POOL_FRAMEBUFFER = 3,
	46	};
	47
61466c65 OG	48	enum kgd_engine_type {
	49	KGD_ENGINE_PFP = 1,
	50	KGD_ENGINE_ME,
	51	KGD_ENGINE_CE,
	52	KGD_ENGINE_MEC1,
	53	KGD_ENGINE_MEC2,
	54	KGD_ENGINE_RLC,
	55	KGD_ENGINE_SDMA,
	56	KGD_ENGINE_MAX
	57	};
	58
e28740ec OG	59	struct kgd2kfd_shared_resources {
	60	/* Bit n == 1 means VMID n is available for KFD. */
	61	unsigned int compute_vmid_bitmap;
	62
	63	/* Compute pipes are counted starting from MEC0/pipe0 as 0. */
	64	unsigned int first_compute_pipe;
	65
	66	/* Number of MEC pipes available for KFD. */
	67	unsigned int compute_pipe_count;
	68
	69	/* Base address of doorbell aperture. */
	70	phys_addr_t doorbell_physical_address;
	71
	72	/* Size in bytes of doorbell aperture. */
	73	size_t doorbell_aperture_size;
	74
	75	/* Number of bytes at start of aperture reserved for KGD. */
	76	size_t doorbell_start_offset;
	77	};
	78
	79	/**
	80	* struct kgd2kfd_calls
	81	*
	82	* @exit: Notifies amdkfd that kgd module is unloaded
	83	*
	84	* @probe: Notifies amdkfd about a probe done on a device in the kgd driver.
	85	*
	86	* @device_init: Initialize the newly probed device (if it is a device that
	87	* amdkfd supports)
	88	*
	89	* @device_exit: Notifies amdkfd about a removal of a kgd device
	90	*
	91	* @suspend: Notifies amdkfd about a suspend action done to a kgd device
	92	*
	93	* @resume: Notifies amdkfd about a resume action done to a kgd device
	94	*
	95	* This structure contains function callback pointers so the kgd driver
	96	* will notify to the amdkfd about certain status changes.
	97	*
	98	*/
	99	struct kgd2kfd_calls {
	100	void (*exit)(void);
	101	struct kfd_dev* (probe)(struct kgd_dev kgd, struct pci_dev *pdev);
	102	bool (device_init)(struct kfd_dev kfd,
	103	const struct kgd2kfd_shared_resources *gpu_resources);
	104	void (device_exit)(struct kfd_dev kfd);
	105	void (interrupt)(struct kfd_dev kfd, const void *ih_ring_entry);
	106	void (suspend)(struct kfd_dev kfd);
	107	int (resume)(struct kfd_dev kfd);
	108	};
	109
	110	/**
	111	* struct kfd2kgd_calls
	112	*
	113	* @init_sa_manager: Initialize an instance of the sa manager, used by
	114	* amdkfd for all system memory allocations that are mapped to the GART
	115	* address space
	116	*
	117	* @fini_sa_manager: Releases all memory allocations for amdkfd that are
	118	* handled by kgd sa manager
	119	*
	120	* @allocate_mem: Allocate a buffer from amdkfd's sa manager. The buffer can
	121	* be used for mqds, hpds, kernel queue, fence and runlists
	122	*
123	* @free_mem: Frees a buffer that was allocated by amdkfd's sa manager
124	*
125	* @get_vmem_size: Retrieves (physical) size of VRAM
126	*
127	* @get_gpu_clock_counter: Retrieves GPU clock counter
128	*
129	* @get_max_engine_clock_in_mhz: Retrieves maximum GPU clock in MHz
130	*
131	* @program_sh_mem_settings: A function that should initiate the memory
132	* properties such as main aperture memory type (cache / non cached) and
133	* secondary aperture base address, size and memory type.
134	* This function is used only for no cp scheduling mode.
135	*
136	* @set_pasid_vmid_mapping: Exposes pasid/vmid pair to the H/W for no cp
137	* scheduling mode. Only used for no cp scheduling mode.
138	*
139	* @init_memory: Initializes memory apertures to fixed base/limit address
140	* and non cached memory types.
141	*
142	* @init_pipeline: Initialized the compute pipelines.
143	*
144	* @hqd_load: Loads the mqd structure to a H/W hqd slot. used only for no cp
145	* sceduling mode.
146	*
147	* @hqd_is_occupies: Checks if a hqd slot is occupied.
148	*
149	* @hqd_destroy: Destructs and preempts the queue assigned to that hqd slot.
150	*
61466c65 OG	151	* @get_fw_version: Returns FW versions from the header
61466c65 OG	152	*
e28740ec OG	153	* This structure contains function pointers to services that the kgd driver
	154	* provides to amdkfd driver.
	155	*
	156	*/
	157	struct kfd2kgd_calls {
	158	/* Memory management. */
	159	int (init_sa_manager)(struct kgd_dev kgd, unsigned int size);
	160	void (fini_sa_manager)(struct kgd_dev kgd);
	161	int (allocate_mem)(struct kgd_dev kgd, size_t size, size_t alignment,
	162	enum kgd_memory_pool pool, struct kgd_mem **mem);
	163
	164	void (free_mem)(struct kgd_dev kgd, struct kgd_mem *mem);
	165
	166	uint64_t (get_vmem_size)(struct kgd_dev kgd);
	167	uint64_t (get_gpu_clock_counter)(struct kgd_dev kgd);
	168
	169	uint32_t (get_max_engine_clock_in_mhz)(struct kgd_dev kgd);
	170
	171	/* Register access functions */
	172	void (program_sh_mem_settings)(struct kgd_dev kgd, uint32_t vmid,
	173	uint32_t sh_mem_config, uint32_t sh_mem_ape1_base,
	174	uint32_t sh_mem_ape1_limit, uint32_t sh_mem_bases);
	175
	176	int (set_pasid_vmid_mapping)(struct kgd_dev kgd, unsigned int pasid,
	177	unsigned int vmid);
	178
	179	int (init_memory)(struct kgd_dev kgd);
	180	int (init_pipeline)(struct kgd_dev kgd, uint32_t pipe_id,
	181	uint32_t hpd_size, uint64_t hpd_gpu_addr);
	182
	183	int (hqd_load)(struct kgd_dev kgd, void *mqd, uint32_t pipe_id,
	184	uint32_t queue_id, uint32_t __user *wptr);
	185
b64b8afc	186	bool (hqd_is_occupied)(struct kgd_dev kgd, uint64_t queue_address,
e28740ec OG	187	uint32_t pipe_id, uint32_t queue_id);
	188
	189	int (hqd_destroy)(struct kgd_dev kgd, uint32_t reset_type,
	190	unsigned int timeout, uint32_t pipe_id,
	191	uint32_t queue_id);
61466c65 OG	192	uint16_t (get_fw_version)(struct kgd_dev kgd,
61466c65 OG	193	enum kgd_engine_type type);
e28740ec OG	194	};
	195
	196	bool kgd2kfd_init(unsigned interface_version,
	197	const struct kfd2kgd_calls *f2g,
	198	const struct kgd2kfd_calls **g2f);
	199
	200	#endif /* KGD_KFD_INTERFACE_H_INCLUDED */