xref: /utopia/UTPA2-700.0.x/modules/usb/drv/usb_ecos/usbhost/include/drvPCIMEM.h (revision 53ee8cc121a030b8d368113ac3e966b4705770ef)
1 //<MStar Software>
2 //******************************************************************************
3 // MStar Software
4 // Copyright (c) 2010 - 2012 MStar Semiconductor, Inc. All rights reserved.
5 // All software, firmware and related documentation herein ("MStar Software") are
6 // intellectual property of MStar Semiconductor, Inc. ("MStar") and protected by
7 // law, including, but not limited to, copyright law and international treaties.
8 // Any use, modification, reproduction, retransmission, or republication of all
9 // or part of MStar Software is expressly prohibited, unless prior written
10 // permission has been granted by MStar.
11 //
12 // By accessing, browsing and/or using MStar Software, you acknowledge that you
13 // have read, understood, and agree, to be bound by below terms ("Terms") and to
14 // comply with all applicable laws and regulations:
15 //
16 // 1. MStar shall retain any and all right, ownership and interest to MStar
17 //    Software and any modification/derivatives thereof.
18 //    No right, ownership, or interest to MStar Software and any
19 //    modification/derivatives thereof is transferred to you under Terms.
20 //
21 // 2. You understand that MStar Software might include, incorporate or be
22 //    supplied together with third party`s software and the use of MStar
23 //    Software may require additional licenses from third parties.
24 //    Therefore, you hereby agree it is your sole responsibility to separately
25 //    obtain any and all third party right and license necessary for your use of
26 //    such third party`s software.
27 //
28 // 3. MStar Software and any modification/derivatives thereof shall be deemed as
29 //    MStar`s confidential information and you agree to keep MStar`s
30 //    confidential information in strictest confidence and not disclose to any
31 //    third party.
32 //
33 // 4. MStar Software is provided on an "AS IS" basis without warranties of any
34 //    kind. Any warranties are hereby expressly disclaimed by MStar, including
35 //    without limitation, any warranties of merchantability, non-infringement of
36 //    intellectual property rights, fitness for a particular purpose, error free
37 //    and in conformity with any international standard.  You agree to waive any
38 //    claim against MStar for any loss, damage, cost or expense that you may
39 //    incur related to your use of MStar Software.
40 //    In no event shall MStar be liable for any direct, indirect, incidental or
41 //    consequential damages, including without limitation, lost of profit or
42 //    revenues, lost or damage of data, and unauthorized system use.
43 //    You agree that this Section 4 shall still apply without being affected
44 //    even if MStar Software has been modified by MStar in accordance with your
45 //    request or instruction for your use, except otherwise agreed by both
46 //    parties in writing.
47 //
48 // 5. If requested, MStar may from time to time provide technical supports or
49 //    services in relation with MStar Software to you for your use of
50 //    MStar Software in conjunction with your or your customer`s product
51 //    ("Services").
52 //    You understand and agree that, except otherwise agreed by both parties in
53 //    writing, Services are provided on an "AS IS" basis and the warranty
54 //    disclaimer set forth in Section 4 above shall apply.
55 //
56 // 6. Nothing contained herein shall be construed as by implication, estoppels
57 //    or otherwise:
58 //    (a) conferring any license or right to use MStar name, trademark, service
59 //        mark, symbol or any other identification;
60 //    (b) obligating MStar or any of its affiliates to furnish any person,
61 //        including without limitation, you and your customers, any assistance
62 //        of any kind whatsoever, or any information; or
63 //    (c) conferring any license or right under any intellectual property right.
64 //
65 // 7. These terms shall be governed by and construed in accordance with the laws
66 //    of Taiwan, R.O.C., excluding its conflict of law rules.
67 //    Any and all dispute arising out hereof or related hereto shall be finally
68 //    settled by arbitration referred to the Chinese Arbitration Association,
69 //    Taipei in accordance with the ROC Arbitration Law and the Arbitration
70 //    Rules of the Association by three (3) arbitrators appointed in accordance
71 //    with the said Rules.
72 //    The place of arbitration shall be in Taipei, Taiwan and the language shall
73 //    be English.
74 //    The arbitration award shall be final and binding to both parties.
75 //
76 //******************************************************************************
77 //<MStar Software>
78 
79 
80 #ifndef _PCI_MEM_MM_H_
81 #define _PCI_MEM_MM_H_
82 
83 #include "drvPorts.h"
84 #include "drvTypes.h"
85 #include "drvOSAPI.h"
86 #include "drvList.h"
87 #include "../drvUsbcommon.h"
88 
89 #define PAGE_SIZE     4096
90 
91 #define BITS_PER_LONG 32
92 
93 /*
94  * ffz = Find First Zero in word. Undefined if no zero exists,
95  * so code should check against ~0UL first..
96  */
ffz(U32 word)97 static __inline__ U32 ffz(U32 word)
98 {
99   int k;
100 
101   word = ~word;
102   k = 31;
103   if (word & 0x0000ffff) { k -= 16; word <<= 16; }
104   if (word & 0x00ff0000) { k -= 8;  word <<= 8;  }
105   if (word & 0x0f000000) { k -= 4;  word <<= 4;  }
106   if (word & 0x30000000) { k -= 2;  word <<= 2;  }
107   if (word & 0x40000000) { k -= 1; }
108         return k;
109 }
110 
111 // Data structure for PCI momery management
112 struct pci_pool {  /* the pool */
113   struct list_head     page_list;
114   spinlock_t       	lock;
115   size_t         		blocks_per_page;
116   size_t         		size;
117   struct pci_dev       *dev;
118   size_t         		allocation;
119   char         		name [32];
120   //wait_queue_head_t  waitq;
121 };
122 
123 struct pci_page {  /* cacheable header for 'allocation' bytes */
124   struct list_head     page_list;
125   void         	*vaddr;
126   void         	*vaddr_rptr;  //Real pointer to the base of the allocated memory
127   dma_addr_t       	dma;
128   U32       	bitmap[0];
129 };
130 
131 //Does not support pci_free_consistent now, just ignore it by macro
132 //#define pci_free_consistent(w,x,y,z)
133 extern struct pci_pool *pci_pool_create (const char *name, struct pci_dev *pdev,
134   size_t size, size_t align, size_t allocation);
135 extern void *pci_pool_alloc (struct pci_pool *pool, int mem_flags, dma_addr_t *handle);
136 extern void pci_pool_destroy (struct pci_pool *pool);
137 extern BOOL pci_pool_free (struct pci_pool *pool, void *vaddr, dma_addr_t dma);
138 
139 #endif
140 
141 
142