xref: /utopia/UTPA2-700.0.x/modules/usb/drv/usb_ecos/usbhost/include/drvPCIMEM.h (revision 53ee8cc121a030b8d368113ac3e966b4705770ef)

//<MStar Software>
//******************************************************************************
// MStar Software
// Copyright (c) 2010 - 2012 MStar Semiconductor, Inc. All rights reserved.
// All software, firmware and related documentation herein ("MStar Software") are
// intellectual property of MStar Semiconductor, Inc. ("MStar") and protected by
// law, including, but not limited to, copyright law and international treaties.
// Any use, modification, reproduction, retransmission, or republication of all
// or part of MStar Software is expressly prohibited, unless prior written
// permission has been granted by MStar.
//
// By accessing, browsing and/or using MStar Software, you acknowledge that you
// have read, understood, and agree, to be bound by below terms ("Terms") and to
// comply with all applicable laws and regulations:
//
// 1. MStar shall retain any and all right, ownership and interest to MStar
//    Software and any modification/derivatives thereof.
//    No right, ownership, or interest to MStar Software and any
//    modification/derivatives thereof is transferred to you under Terms.
//
// 2. You understand that MStar Software might include, incorporate or be
//    supplied together with third party`s software and the use of MStar
//    Software may require additional licenses from third parties.
//    Therefore, you hereby agree it is your sole responsibility to separately
//    obtain any and all third party right and license necessary for your use of
//    such third party`s software.
//
// 3. MStar Software and any modification/derivatives thereof shall be deemed as
//    MStar`s confidential information and you agree to keep MStar`s
//    confidential information in strictest confidence and not disclose to any
//    third party.
//
// 4. MStar Software is provided on an "AS IS" basis without warranties of any
//    kind. Any warranties are hereby expressly disclaimed by MStar, including
//    without limitation, any warranties of merchantability, non-infringement of
//    intellectual property rights, fitness for a particular purpose, error free
//    and in conformity with any international standard.  You agree to waive any
//    claim against MStar for any loss, damage, cost or expense that you may
//    incur related to your use of MStar Software.
//    In no event shall MStar be liable for any direct, indirect, incidental or
//    consequential damages, including without limitation, lost of profit or
//    revenues, lost or damage of data, and unauthorized system use.
//    You agree that this Section 4 shall still apply without being affected
//    even if MStar Software has been modified by MStar in accordance with your
//    request or instruction for your use, except otherwise agreed by both
//    parties in writing.
//
// 5. If requested, MStar may from time to time provide technical supports or
//    services in relation with MStar Software to you for your use of
//    MStar Software in conjunction with your or your customer`s product
//    ("Services").
//    You understand and agree that, except otherwise agreed by both parties in
//    writing, Services are provided on an "AS IS" basis and the warranty
//    disclaimer set forth in Section 4 above shall apply.
//
// 6. Nothing contained herein shall be construed as by implication, estoppels
//    or otherwise:
//    (a) conferring any license or right to use MStar name, trademark, service
//        mark, symbol or any other identification;
//    (b) obligating MStar or any of its affiliates to furnish any person,
//        including without limitation, you and your customers, any assistance
//        of any kind whatsoever, or any information; or
//    (c) conferring any license or right under any intellectual property right.
//
// 7. These terms shall be governed by and construed in accordance with the laws
//    of Taiwan, R.O.C., excluding its conflict of law rules.
//    Any and all dispute arising out hereof or related hereto shall be finally
//    settled by arbitration referred to the Chinese Arbitration Association,
//    Taipei in accordance with the ROC Arbitration Law and the Arbitration
//    Rules of the Association by three (3) arbitrators appointed in accordance
//    with the said Rules.
//    The place of arbitration shall be in Taipei, Taiwan and the language shall
//    be English.
//    The arbitration award shall be final and binding to both parties.
//
//******************************************************************************
//<MStar Software>


#ifndef _PCI_MEM_MM_H_
#define _PCI_MEM_MM_H_

#include "drvPorts.h"
#include "drvTypes.h"
#include "drvOSAPI.h"
#include "drvList.h"
#include "../drvUsbcommon.h"

#define PAGE_SIZE     4096

#define BITS_PER_LONG 32

/*
 * ffz = Find First Zero in word. Undefined if no zero exists,
 * so code should check against ~0UL first..
 */
static __inline__ U32 ffz(U32 word)
{
  int k;

  word = ~word;
  k = 31;
  if (word & 0x0000ffff) { k -= 16; word <<= 16; }
  if (word & 0x00ff0000) { k -= 8;  word <<= 8;  }
  if (word & 0x0f000000) { k -= 4;  word <<= 4;  }
  if (word & 0x30000000) { k -= 2;  word <<= 2;  }
  if (word & 0x40000000) { k -= 1; }
        return k;
}

// Data structure for PCI momery management
struct pci_pool {  /* the pool */
  struct list_head     page_list;
  spinlock_t       	lock;
  size_t         		blocks_per_page;
  size_t         		size;
  struct pci_dev       *dev;
  size_t         		allocation;
  char         		name [32];
  //wait_queue_head_t  waitq;
};

struct pci_page {  /* cacheable header for 'allocation' bytes */
  struct list_head     page_list;
  void         	*vaddr;
  void         	*vaddr_rptr;  //Real pointer to the base of the allocated memory
  dma_addr_t       	dma;
  U32       	bitmap[0];
};

//Does not support pci_free_consistent now, just ignore it by macro
//#define pci_free_consistent(w,x,y,z)
extern struct pci_pool *pci_pool_create (const char *name, struct pci_dev *pdev,
  size_t size, size_t align, size_t allocation);
extern void *pci_pool_alloc (struct pci_pool *pool, int mem_flags, dma_addr_t *handle);
extern void pci_pool_destroy (struct pci_pool *pool);
extern BOOL pci_pool_free (struct pci_pool *pool, void *vaddr, dma_addr_t dma);

#endif