xref: /wlan-dirver/qca-wifi-host-cmn/qdf/inc/qdf_dev.h (revision 1b9674e21e24478fba4530f5ae7396b9555e9c6a)
1 /*
2  * Copyright (c) 2018 The Linux Foundation. All rights reserved.
3  *
4  * Permission to use, copy, modify, and/or distribute this software for
5  * any purpose with or without fee is hereby granted, provided that the
6  * above copyright notice and this permission notice appear in all
7  * copies.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
10  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
11  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
12  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
13  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
14  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
15  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
16  * PERFORMANCE OF THIS SOFTWARE.
17  */
18 
19 /**
20  * DOC: qdf_dev
21  * QCA driver framework (QDF) device management APIs
22  */
23 
24 #if !defined(__QDF_DEV_H)
25 #define __QDF_DEV_H
26 
27 /* Include Files */
28 #include <qdf_types.h>
29 
30 struct qdf_cpu_mask;
31 struct qdf_devm;
32 
33 /**
34  * qdf_dev_alloc_mem() - allocate memory
35  * @qdfdev: Device handle
36  * @mrptr: Pointer to the allocated memory
37  * @reqsize: Allocation request in bytes
38  * @mask: Property mask to be associated to the allocated memory
39  *
40  * This function will acquire memory to be associated with a device
41  *
42  * Return: QDF_STATUS_SUCCESS on success
43  */
44 QDF_STATUS
45 qdf_dev_alloc_mem(qdf_device_t qdfdev, struct qdf_devm **mrptr,
46 		  uint32_t reqsize, uint32_t mask);
47 
48 /**
49  * qdf_dev_release_mem() - release memory
50  * @qdfdev: Device handle
51  * @mrptr: Pointer to the allocated memory
52  *
53  * This function will acquire memory to be associated with a device
54  *
55  * Return: QDF_STATUS_SUCCESS on success
56  */
57 QDF_STATUS
58 qdf_dev_release_mem(qdf_device_t qdfdev, struct qdf_devm *mrptr);
59 
60 /**
61  * qdf_dev_modify_irq() - modify irq
62  * @irnum: irq number
63  * @cmask: Bitmap to be cleared for the property mask
64  * @smask: Bitmap to be set for the property mask
65  *
66  * This function will acquire memory to be associated with a device
67  *
68  * Return: QDF_STATUS_SUCCESS on success
69  */
70 QDF_STATUS
71 qdf_dev_modify_irq_status(uint32_t irnum, unsigned long cmask,
72 			  unsigned long smask);
73 
74 /**
75  * qdf_dev_set_irq_affinity() - set irq affinity
76  * @irnum: irq number
77  * @cpmask: cpu affinity bitmap
78  *
79  * This function will set the affinity level for an irq
80  *
81  * Return: QDF_STATUS_SUCCESS on success
82  */
83 QDF_STATUS
84 qdf_dev_set_irq_affinity(uint32_t irnum, struct qdf_cpu_mask *cpmask);
85 #endif
86