include/linux/msm_ion.h - kernel/msm - Gitiles

 /*
  *
  * Copyright (c) 2012, The Linux Foundation. All rights reserved.
  *
  * This software is licensed under the terms of the GNU General Public
  * License version 2, as published by the Free Software Foundation, and
  * may be copied, distributed, and modified under those terms.
  *
  * 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.
  *
  */

 #ifndef _LINUX_MSM_ION_H
 #define _LINUX_MSM_ION_H

 #include <linux/ion.h>

 enum msm_ion_heap_types {
 	ION_HEAP_TYPE_MSM_START = ION_HEAP_TYPE_CUSTOM + 1,
 	ION_HEAP_TYPE_IOMMU = ION_HEAP_TYPE_MSM_START,
 	ION_HEAP_TYPE_CP,
 };

 /**
  * These are the only ids that should be used for Ion heap ids.
  * The ids listed are the order in which allocation will be attempted
  * if specified. Don't swap the order of heap ids unless you know what
  * you are doing!
  * Id's are spaced by purpose to allow new Id's to be inserted in-between (for
  * possible fallbacks)
  */

 enum ion_heap_ids {
 	INVALID_HEAP_ID = -1,
 	ION_CP_MM_HEAP_ID = 8,
 	ION_CP_MFC_HEAP_ID = 12,
 	ION_CP_WB_HEAP_ID = 16, /* 8660 only */
 	ION_CAMERA_HEAP_ID = 20, /* 8660 only */
 	ION_PIL1_HEAP_ID = 23, /* Currently used for other PIL images */
 	ION_SF_HEAP_ID = 24,
 	ION_IOMMU_HEAP_ID = 25,
 	ION_PIL2_HEAP_ID = 26, /* Currently used for modem firmware images */
 	ION_QSECOM_HEAP_ID = 27,
 	ION_AUDIO_HEAP_ID = 28,

 	ION_MM_FIRMWARE_HEAP_ID = 29,
 	ION_SYSTEM_HEAP_ID = 30,

 	ION_HEAP_ID_RESERVED = 31 /** Bit reserved for ION_SECURE flag */
 };

 enum ion_fixed_position {
 	NOT_FIXED,
 	FIXED_LOW,
 	FIXED_MIDDLE,
 	FIXED_HIGH,
 };

 enum cp_mem_usage {
 	VIDEO_BITSTREAM = 0x1,
 	VIDEO_PIXEL = 0x2,
 	VIDEO_NONPIXEL = 0x3,
 	MAX_USAGE = 0x4,
 	UNKNOWN = 0x7FFFFFFF,
 };

 #define ION_HEAP_CP_MASK		(1 << ION_HEAP_TYPE_CP)

 /**
  * Flag to use when allocating to indicate that a heap is secure.
  */
 #define ION_SECURE (1 << ION_HEAP_ID_RESERVED)

 /**
  * Macro should be used with ion_heap_ids defined above.
  */
 #define ION_HEAP(bit) (1 << (bit))

 #define ION_VMALLOC_HEAP_NAME	"vmalloc"
 #define ION_AUDIO_HEAP_NAME	"audio"
 #define ION_SF_HEAP_NAME	"sf"
 #define ION_MM_HEAP_NAME	"mm"
 #define ION_CAMERA_HEAP_NAME	"camera_preview"
 #define ION_IOMMU_HEAP_NAME	"iommu"
 #define ION_MFC_HEAP_NAME	"mfc"
 #define ION_WB_HEAP_NAME	"wb"
 #define ION_MM_FIRMWARE_HEAP_NAME	"mm_fw"
 #define ION_PIL1_HEAP_NAME  "pil_1"
 #define ION_PIL2_HEAP_NAME  "pil_2"
 #define ION_QSECOM_HEAP_NAME	"qsecom"
 #define ION_FMEM_HEAP_NAME	"fmem"

 #define ION_SET_CACHED(__cache)		(__cache | ION_FLAG_CACHED)
 #define ION_SET_UNCACHED(__cache)	(__cache & ~ION_FLAG_CACHED)

 #define ION_IS_CACHED(__flags)	((__flags) & ION_FLAG_CACHED)

 #ifdef __KERNEL__

 /*
  * This flag allows clients when mapping into the IOMMU to specify to
  * defer un-mapping from the IOMMU until the buffer memory is freed.
  */
 #define ION_IOMMU_UNMAP_DELAYED 1

 /*
  * This flag allows clients to defer unsecuring a buffer until the buffer
  * is actually freed.
  */
 #define ION_UNSECURE_DELAYED	1

 /**
  * struct ion_cp_heap_pdata - defines a content protection heap in the given
  * platform
  * @permission_type:	Memory ID used to identify the memory to TZ
  * @align:		Alignment requirement for the memory
  * @secure_base:	Base address for securing the heap.
  *			Note: This might be different from actual base address
  *			of this heap in the case of a shared heap.
  * @secure_size:	Memory size for securing the heap.
  *			Note: This might be different from actual size
  *			of this heap in the case of a shared heap.
  * @reusable		Flag indicating whether this heap is reusable of not.
  *			(see FMEM)
  * @mem_is_fmem		Flag indicating whether this memory is coming from fmem
  *			or not.
  * @fixed_position	If nonzero, position in the fixed area.
  * @virt_addr:		Virtual address used when using fmem.
  * @iommu_map_all:	Indicates whether we should map whole heap into IOMMU.
  * @iommu_2x_map_domain: Indicates the domain to use for overmapping.
  * @request_region:	function to be called when the number of allocations
  *			goes from 0 -> 1
  * @release_region:	function to be called when the number of allocations
  *			goes from 1 -> 0
  * @setup_region:	function to be called upon ion registration
  * @memory_type:Memory type used for the heap
  *
  */
 struct ion_cp_heap_pdata {
 	enum ion_permission_type permission_type;
 	unsigned int align;
 	ion_phys_addr_t secure_base; /* Base addr used when heap is shared */
 	size_t secure_size; /* Size used for securing heap when heap is shared*/
 	int reusable;
 	int mem_is_fmem;
 	enum ion_fixed_position fixed_position;
 	int iommu_map_all;
 	int iommu_2x_map_domain;
 	ion_virt_addr_t *virt_addr;
 	int (*request_region)(void *);
 	int (*release_region)(void *);
 	void *(*setup_region)(void);
 	enum ion_memory_types memory_type;
 };

 /**
  * struct ion_co_heap_pdata - defines a carveout heap in the given platform
  * @adjacent_mem_id:	Id of heap that this heap must be adjacent to.
  * @align:		Alignment requirement for the memory
  * @mem_is_fmem		Flag indicating whether this memory is coming from fmem
  *			or not.
  * @fixed_position	If nonzero, position in the fixed area.
  * @request_region:	function to be called when the number of allocations
  *			goes from 0 -> 1
  * @release_region:	function to be called when the number of allocations
  *			goes from 1 -> 0
  * @setup_region:	function to be called upon ion registration
  * @memory_type:Memory type used for the heap
  *
  */
 struct ion_co_heap_pdata {
 	int adjacent_mem_id;
 	unsigned int align;
 	int mem_is_fmem;
 	enum ion_fixed_position fixed_position;
 	int (*request_region)(void *);
 	int (*release_region)(void *);
 	void *(*setup_region)(void);
 	enum ion_memory_types memory_type;
 };

 #ifdef CONFIG_ION
 /**
  * msm_ion_secure_heap - secure a heap. Wrapper around ion_secure_heap.
  *
   * @heap_id - heap id to secure.
  *
  * Secure a heap
  * Returns 0 on success
  */
 int msm_ion_secure_heap(int heap_id);

 /**
  * msm_ion_unsecure_heap - unsecure a heap. Wrapper around ion_unsecure_heap.
  *
   * @heap_id - heap id to secure.
  *
  * Un-secure a heap
  * Returns 0 on success
  */
 int msm_ion_unsecure_heap(int heap_id);

 /**
  * msm_ion_secure_heap_2_0 - secure a heap using 2.0 APIs
  *  Wrapper around ion_secure_heap.
  *
  * @heap_id - heap id to secure.
  * @usage - usage hint to TZ
  *
  * Secure a heap
  * Returns 0 on success
  */
 int msm_ion_secure_heap_2_0(int heap_id, enum cp_mem_usage usage);

 /**
  * msm_ion_unsecure_heap - unsecure a heap secured with 3.0 APIs.
  * Wrapper around ion_unsecure_heap.
  *
  * @heap_id - heap id to secure.
  * @usage - usage hint to TZ
  *
  * Un-secure a heap
  * Returns 0 on success
  */
 int msm_ion_unsecure_heap_2_0(int heap_id, enum cp_mem_usage usage);

 /**
  * msm_ion_secure_buffer - secure an individual buffer
  *
  * @client - client who has access to the buffer
  * @handle - buffer to secure
  * @usage - usage hint to TZ
  * @flags - flags for the securing
  */
 int msm_ion_secure_buffer(struct ion_client *client, struct ion_handle *handle,
 				enum cp_mem_usage usage, int flags);

 /**
  * msm_ion_unsecure_buffer - unsecure an individual buffer
  *
  * @client - client who has access to the buffer
  * @handle - buffer to secure
  */
 int msm_ion_unsecure_buffer(struct ion_client *client,
 				struct ion_handle *handle);
 #else
 static inline int msm_ion_secure_heap(int heap_id)
 {
 	return -ENODEV;

 }

 static inline int msm_ion_unsecure_heap(int heap_id)
 {
 	return -ENODEV;
 }

 static inline int msm_ion_secure_heap_2_0(int heap_id, enum cp_mem_usage usage)
 {
 	return -ENODEV;
 }

 static inline int msm_ion_unsecure_heap_2_0(int heap_id,
 					enum cp_mem_usage usage)
 {
 	return -ENODEV;
 }
 #endif /* CONFIG_ION */

 #endif /* __KERNEL */

 /* struct ion_flush_data - data passed to ion for flushing caches
  *
  * @handle:	handle with data to flush
  * @fd:		fd to flush
  * @vaddr:	userspace virtual address mapped with mmap
  * @offset:	offset into the handle to flush
  * @length:	length of handle to flush
  *
  * Performs cache operations on the handle. If p is the start address
  * of the handle, p + offset through p + offset + length will have
  * the cache operations performed
  */
 struct ion_flush_data {
 	struct ion_handle *handle;
 	int fd;
 	void *vaddr;
 	unsigned int offset;
 	unsigned int length;
 };

 /* struct ion_flag_data - information about flags for this buffer
  *
  * @handle:	handle to get flags from
  * @flags:	flags of this handle
  *
  * Takes handle as an input and outputs the flags from the handle
  * in the flag field.
  */
 struct ion_flag_data {
 	struct ion_handle *handle;
 	unsigned long flags;
 };

 #define ION_IOC_MSM_MAGIC 'M'

 /**
  * DOC: ION_IOC_CLEAN_CACHES - clean the caches
  *
  * Clean the caches of the handle specified.
  */
 #define ION_IOC_CLEAN_CACHES	_IOWR(ION_IOC_MSM_MAGIC, 0, \
 						struct ion_flush_data)
 /**
  * DOC: ION_IOC_INV_CACHES - invalidate the caches
  *
  * Invalidate the caches of the handle specified.
  */
 #define ION_IOC_INV_CACHES	_IOWR(ION_IOC_MSM_MAGIC, 1, \
 						struct ion_flush_data)
 /**
  * DOC: ION_IOC_CLEAN_INV_CACHES - clean and invalidate the caches
  *
  * Clean and invalidate the caches of the handle specified.
  */
 #define ION_IOC_CLEAN_INV_CACHES	_IOWR(ION_IOC_MSM_MAGIC, 2, \
 						struct ion_flush_data)

 /**
  * DOC: ION_IOC_GET_FLAGS - get the flags of the handle
  *
  * Gets the flags of the current handle which indicate cachability,
  * secure state etc.
  */
 #define ION_IOC_GET_FLAGS		_IOWR(ION_IOC_MSM_MAGIC, 3, \
 						struct ion_flag_data)

 #endif
	/*
	*
	* Copyright (c) 2012, The Linux Foundation. All rights reserved.
	*
	* This software is licensed under the terms of the GNU General Public
	* License version 2, as published by the Free Software Foundation, and
	* may be copied, distributed, and modified under those terms.
	*
	* 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.
	*
	*/

	#ifndef _LINUX_MSM_ION_H
	#define _LINUX_MSM_ION_H

	#include <linux/ion.h>

	enum msm_ion_heap_types {
	ION_HEAP_TYPE_MSM_START = ION_HEAP_TYPE_CUSTOM + 1,
	ION_HEAP_TYPE_IOMMU = ION_HEAP_TYPE_MSM_START,
	ION_HEAP_TYPE_CP,
	};

	/**
	* These are the only ids that should be used for Ion heap ids.
	* The ids listed are the order in which allocation will be attempted
	* if specified. Don't swap the order of heap ids unless you know what
	* you are doing!
	* Id's are spaced by purpose to allow new Id's to be inserted in-between (for
	* possible fallbacks)
	*/

	enum ion_heap_ids {
	INVALID_HEAP_ID = -1,
	ION_CP_MM_HEAP_ID = 8,
	ION_CP_MFC_HEAP_ID = 12,
	ION_CP_WB_HEAP_ID = 16, /* 8660 only */
	ION_CAMERA_HEAP_ID = 20, /* 8660 only */
	ION_PIL1_HEAP_ID = 23, /* Currently used for other PIL images */
	ION_SF_HEAP_ID = 24,
	ION_IOMMU_HEAP_ID = 25,
	ION_PIL2_HEAP_ID = 26, /* Currently used for modem firmware images */
	ION_QSECOM_HEAP_ID = 27,
	ION_AUDIO_HEAP_ID = 28,

	ION_MM_FIRMWARE_HEAP_ID = 29,
	ION_SYSTEM_HEAP_ID = 30,

	ION_HEAP_ID_RESERVED = 31 /** Bit reserved for ION_SECURE flag */
	};

	enum ion_fixed_position {
	NOT_FIXED,
	FIXED_LOW,
	FIXED_MIDDLE,
	FIXED_HIGH,
	};

	enum cp_mem_usage {
	VIDEO_BITSTREAM = 0x1,
	VIDEO_PIXEL = 0x2,
	VIDEO_NONPIXEL = 0x3,
	MAX_USAGE = 0x4,
	UNKNOWN = 0x7FFFFFFF,
	};

	#define ION_HEAP_CP_MASK (1 << ION_HEAP_TYPE_CP)

	/**
	* Flag to use when allocating to indicate that a heap is secure.
	*/
	#define ION_SECURE (1 << ION_HEAP_ID_RESERVED)

	/**
	* Macro should be used with ion_heap_ids defined above.
	*/
	#define ION_HEAP(bit) (1 << (bit))

	#define ION_VMALLOC_HEAP_NAME "vmalloc"
	#define ION_AUDIO_HEAP_NAME "audio"
	#define ION_SF_HEAP_NAME "sf"
	#define ION_MM_HEAP_NAME "mm"
	#define ION_CAMERA_HEAP_NAME "camera_preview"
	#define ION_IOMMU_HEAP_NAME "iommu"
	#define ION_MFC_HEAP_NAME "mfc"
	#define ION_WB_HEAP_NAME "wb"
	#define ION_MM_FIRMWARE_HEAP_NAME "mm_fw"
	#define ION_PIL1_HEAP_NAME "pil_1"
	#define ION_PIL2_HEAP_NAME "pil_2"
	#define ION_QSECOM_HEAP_NAME "qsecom"
	#define ION_FMEM_HEAP_NAME "fmem"

	#define ION_SET_CACHED(__cache) (__cache \| ION_FLAG_CACHED)
	#define ION_SET_UNCACHED(__cache) (__cache & ~ION_FLAG_CACHED)

	#define ION_IS_CACHED(__flags) ((__flags) & ION_FLAG_CACHED)

	#ifdef __KERNEL__

	/*
	* This flag allows clients when mapping into the IOMMU to specify to
	* defer un-mapping from the IOMMU until the buffer memory is freed.
	*/
	#define ION_IOMMU_UNMAP_DELAYED 1

	/*
	* This flag allows clients to defer unsecuring a buffer until the buffer
	* is actually freed.
	*/
	#define ION_UNSECURE_DELAYED 1

	/**
	* struct ion_cp_heap_pdata - defines a content protection heap in the given
	* platform
	* @permission_type: Memory ID used to identify the memory to TZ
	* @align: Alignment requirement for the memory
	* @secure_base: Base address for securing the heap.
	* Note: This might be different from actual base address
	* of this heap in the case of a shared heap.
	* @secure_size: Memory size for securing the heap.
	* Note: This might be different from actual size
	* of this heap in the case of a shared heap.
	* @reusable Flag indicating whether this heap is reusable of not.
	* (see FMEM)
	* @mem_is_fmem Flag indicating whether this memory is coming from fmem
	* or not.
	* @fixed_position If nonzero, position in the fixed area.
	* @virt_addr: Virtual address used when using fmem.
	* @iommu_map_all: Indicates whether we should map whole heap into IOMMU.
	* @iommu_2x_map_domain: Indicates the domain to use for overmapping.
	* @request_region: function to be called when the number of allocations
	* goes from 0 -> 1
	* @release_region: function to be called when the number of allocations
	* goes from 1 -> 0
	* @setup_region: function to be called upon ion registration
	* @memory_type:Memory type used for the heap
	*
	*/
	struct ion_cp_heap_pdata {
	enum ion_permission_type permission_type;
	unsigned int align;
	ion_phys_addr_t secure_base; /* Base addr used when heap is shared */
	size_t secure_size; /* Size used for securing heap when heap is shared*/
	int reusable;
	int mem_is_fmem;
	enum ion_fixed_position fixed_position;
	int iommu_map_all;
	int iommu_2x_map_domain;
	ion_virt_addr_t *virt_addr;
	int (request_region)(void );
	int (release_region)(void );
	void (setup_region)(void);
	enum ion_memory_types memory_type;
	};

	/**
	* struct ion_co_heap_pdata - defines a carveout heap in the given platform
	* @adjacent_mem_id: Id of heap that this heap must be adjacent to.
	* @align: Alignment requirement for the memory
	* @mem_is_fmem Flag indicating whether this memory is coming from fmem
	* or not.
	* @fixed_position If nonzero, position in the fixed area.
	* @request_region: function to be called when the number of allocations
	* goes from 0 -> 1
	* @release_region: function to be called when the number of allocations
	* goes from 1 -> 0
	* @setup_region: function to be called upon ion registration
	* @memory_type:Memory type used for the heap
	*
	*/
	struct ion_co_heap_pdata {
	int adjacent_mem_id;
	unsigned int align;
	int mem_is_fmem;
	enum ion_fixed_position fixed_position;
	int (request_region)(void );
	int (release_region)(void );
	void (setup_region)(void);
	enum ion_memory_types memory_type;
	};

	#ifdef CONFIG_ION
	/**
	* msm_ion_secure_heap - secure a heap. Wrapper around ion_secure_heap.
	*
	* @heap_id - heap id to secure.
	*
	* Secure a heap
	* Returns 0 on success
	*/
	int msm_ion_secure_heap(int heap_id);

	/**
	* msm_ion_unsecure_heap - unsecure a heap. Wrapper around ion_unsecure_heap.
	*
	* @heap_id - heap id to secure.
	*
	* Un-secure a heap
	* Returns 0 on success
	*/
	int msm_ion_unsecure_heap(int heap_id);

	/**
	* msm_ion_secure_heap_2_0 - secure a heap using 2.0 APIs
	* Wrapper around ion_secure_heap.
	*
	* @heap_id - heap id to secure.
	* @usage - usage hint to TZ
	*
	* Secure a heap
	* Returns 0 on success
	*/
	int msm_ion_secure_heap_2_0(int heap_id, enum cp_mem_usage usage);

	/**
	* msm_ion_unsecure_heap - unsecure a heap secured with 3.0 APIs.
	* Wrapper around ion_unsecure_heap.
	*
	* @heap_id - heap id to secure.
	* @usage - usage hint to TZ
	*
	* Un-secure a heap
	* Returns 0 on success
	*/
	int msm_ion_unsecure_heap_2_0(int heap_id, enum cp_mem_usage usage);

	/**
	* msm_ion_secure_buffer - secure an individual buffer
	*
	* @client - client who has access to the buffer
	* @handle - buffer to secure
	* @usage - usage hint to TZ
	* @flags - flags for the securing
	*/
	int msm_ion_secure_buffer(struct ion_client client, struct ion_handle handle,
	enum cp_mem_usage usage, int flags);

	/**
	* msm_ion_unsecure_buffer - unsecure an individual buffer
	*
	* @client - client who has access to the buffer
	* @handle - buffer to secure
	*/
	int msm_ion_unsecure_buffer(struct ion_client *client,
	struct ion_handle *handle);
	#else
	static inline int msm_ion_secure_heap(int heap_id)
	{
	return -ENODEV;

	}

	static inline int msm_ion_unsecure_heap(int heap_id)
	{
	return -ENODEV;
	}

	static inline int msm_ion_secure_heap_2_0(int heap_id, enum cp_mem_usage usage)
	{
	return -ENODEV;
	}

	static inline int msm_ion_unsecure_heap_2_0(int heap_id,
	enum cp_mem_usage usage)
	{
	return -ENODEV;
	}
	#endif /* CONFIG_ION */

	#endif /* __KERNEL */

	/* struct ion_flush_data - data passed to ion for flushing caches
	*
	* @handle: handle with data to flush
	* @fd: fd to flush
	* @vaddr: userspace virtual address mapped with mmap
	* @offset: offset into the handle to flush
	* @length: length of handle to flush
	*
	* Performs cache operations on the handle. If p is the start address
	* of the handle, p + offset through p + offset + length will have
	* the cache operations performed
	*/
	struct ion_flush_data {
	struct ion_handle *handle;
	int fd;
	void *vaddr;
	unsigned int offset;
	unsigned int length;
	};

	/* struct ion_flag_data - information about flags for this buffer
	*
	* @handle: handle to get flags from
	* @flags: flags of this handle
	*
	* Takes handle as an input and outputs the flags from the handle
	* in the flag field.
	*/
	struct ion_flag_data {
	struct ion_handle *handle;
	unsigned long flags;
	};

	#define ION_IOC_MSM_MAGIC 'M'

	/**
	* DOC: ION_IOC_CLEAN_CACHES - clean the caches
	*
	* Clean the caches of the handle specified.
	*/
	#define ION_IOC_CLEAN_CACHES _IOWR(ION_IOC_MSM_MAGIC, 0, \
	struct ion_flush_data)
	/**
	* DOC: ION_IOC_INV_CACHES - invalidate the caches
	*
	* Invalidate the caches of the handle specified.
	*/
	#define ION_IOC_INV_CACHES _IOWR(ION_IOC_MSM_MAGIC, 1, \
	struct ion_flush_data)
	/**
	* DOC: ION_IOC_CLEAN_INV_CACHES - clean and invalidate the caches
	*
	* Clean and invalidate the caches of the handle specified.
	*/
	#define ION_IOC_CLEAN_INV_CACHES _IOWR(ION_IOC_MSM_MAGIC, 2, \
	struct ion_flush_data)

	/**
	* DOC: ION_IOC_GET_FLAGS - get the flags of the handle
	*
	* Gets the flags of the current handle which indicate cachability,
	* secure state etc.
	*/
	#define ION_IOC_GET_FLAGS _IOWR(ION_IOC_MSM_MAGIC, 3, \
	struct ion_flag_data)

	#endif