iommu.h

Go to the documentation of this file.

/*
 * omap iommu: main structures
 *
 * Copyright (C) 2008-2009 Nokia Corporation
 *
 * Written by Hiroshi DOYU <[email protected]>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

#ifndef __MACH_IOMMU_H
#define __MACH_IOMMU_H

struct iotlb_entry {
    u32 da;
    u32 pa;
    u32 pgsz, prsvd, valid;
    union {
        u16 ap;
        struct {
            u32 endian, elsz, mixed;
        };
    };
};

struct omap_iommu {
    const char  *name;
    struct module   *owner;
    struct clk  *clk;
    void __iomem    *regbase;
    struct device   *dev;
    void        *isr_priv;
    struct iommu_domain *domain;

    unsigned int    refcount;
    spinlock_t  iommu_lock; /* global for this whole object */

    /*
     * We don't change iopgd for a situation like pgd for a task,
     * but share it globally for each iommu.
     */
    u32     *iopgd;
    spinlock_t  page_table_lock; /* protect iopgd */

    int     nr_tlb_entries;

    struct list_head    mmap;
    struct mutex        mmap_lock; /* protect mmap */

    void *ctx; /* iommu context: registres saved area */
    u32 da_start;
    u32 da_end;
};

struct cr_regs {
    union {
        struct {
            u16 cam_l;
            u16 cam_h;
        };
        u32 cam;
    };
    union {
        struct {
            u16 ram_l;
            u16 ram_h;
        };
        u32 ram;
    };
};

struct iotlb_lock {
    short base;
    short vict;
};

/* architecture specific functions */
struct iommu_functions {
    unsigned long   version;

    int (*enable)(struct omap_iommu *obj);
    void (*disable)(struct omap_iommu *obj);
    void (*set_twl)(struct omap_iommu *obj, bool on);
    u32 (*fault_isr)(struct omap_iommu *obj, u32 *ra);

    void (*tlb_read_cr)(struct omap_iommu *obj, struct cr_regs *cr);
    void (*tlb_load_cr)(struct omap_iommu *obj, struct cr_regs *cr);

    struct cr_regs *(*alloc_cr)(struct omap_iommu *obj,
                            struct iotlb_entry *e);
    int (*cr_valid)(struct cr_regs *cr);
    u32 (*cr_to_virt)(struct cr_regs *cr);
    void (*cr_to_e)(struct cr_regs *cr, struct iotlb_entry *e);
    ssize_t (*dump_cr)(struct omap_iommu *obj, struct cr_regs *cr,
                            char *buf);

    u32 (*get_pte_attr)(struct iotlb_entry *e);

    void (*save_ctx)(struct omap_iommu *obj);
    void (*restore_ctx)(struct omap_iommu *obj);
    ssize_t (*dump_ctx)(struct omap_iommu *obj, char *buf, ssize_t len);
};

struct omap_mmu_dev_attr {
    u32 da_start;
    u32 da_end;
    int nr_tlb_entries;
};

struct iommu_platform_data {
    const char *name;
    const char *clk_name;
    const int nr_tlb_entries;
    u32 da_start;
    u32 da_end;
};

struct omap_iommu_arch_data {
    const char *name;
    struct omap_iommu *iommu_dev;
};

#ifdef CONFIG_IOMMU_API

static inline struct omap_iommu *dev_to_omap_iommu(struct device *dev)
{
    struct omap_iommu_arch_data *arch_data = dev->archdata.iommu;

    return arch_data->iommu_dev;
}
#endif

/* IOMMU errors */
#define OMAP_IOMMU_ERR_TLB_MISS     (1 << 0)
#define OMAP_IOMMU_ERR_TRANS_FAULT  (1 << 1)
#define OMAP_IOMMU_ERR_EMU_MISS     (1 << 2)
#define OMAP_IOMMU_ERR_TBLWALK_FAULT    (1 << 3)
#define OMAP_IOMMU_ERR_MULTIHIT_FAULT   (1 << 4)

#if defined(CONFIG_ARCH_OMAP1)
#error "iommu for this processor not implemented yet"
#else
#include <plat/iommu2.h>
#endif

/*
 * utilities for super page(16MB, 1MB, 64KB and 4KB)
 */

#define iopgsz_max(bytes)           \
    (((bytes) >= SZ_16M) ? SZ_16M :     \
     ((bytes) >= SZ_1M)  ? SZ_1M  :     \
     ((bytes) >= SZ_64K) ? SZ_64K :     \
     ((bytes) >= SZ_4K)  ? SZ_4K  : 0)

#define bytes_to_iopgsz(bytes)              \
    (((bytes) == SZ_16M) ? MMU_CAM_PGSZ_16M :   \
     ((bytes) == SZ_1M)  ? MMU_CAM_PGSZ_1M  :   \
     ((bytes) == SZ_64K) ? MMU_CAM_PGSZ_64K :   \
     ((bytes) == SZ_4K)  ? MMU_CAM_PGSZ_4K  : -1)

#define iopgsz_to_bytes(iopgsz)             \
    (((iopgsz) == MMU_CAM_PGSZ_16M) ? SZ_16M :  \
     ((iopgsz) == MMU_CAM_PGSZ_1M)  ? SZ_1M  :  \
     ((iopgsz) == MMU_CAM_PGSZ_64K) ? SZ_64K :  \
     ((iopgsz) == MMU_CAM_PGSZ_4K)  ? SZ_4K  : 0)

#define iopgsz_ok(bytes) (bytes_to_iopgsz(bytes) >= 0)

/*
 * global functions
 */
extern u32 omap_iommu_arch_version(void);

extern void omap_iotlb_cr_to_e(struct cr_regs *cr, struct iotlb_entry *e);

extern int
omap_iopgtable_store_entry(struct omap_iommu *obj, struct iotlb_entry *e);

extern int omap_iommu_set_isr(const char *name,
         int (*isr)(struct omap_iommu *obj, u32 da, u32 iommu_errs,
                    void *priv),
             void *isr_priv);

extern void omap_iommu_save_ctx(struct device *dev);
extern void omap_iommu_restore_ctx(struct device *dev);

extern int omap_install_iommu_arch(const struct iommu_functions *ops);
extern void omap_uninstall_iommu_arch(const struct iommu_functions *ops);

extern int omap_foreach_iommu_device(void *data,
                int (*fn)(struct device *, void *));

extern ssize_t
omap_iommu_dump_ctx(struct omap_iommu *obj, char *buf, ssize_t len);
extern size_t
omap_dump_tlb_entries(struct omap_iommu *obj, char *buf, ssize_t len);

#endif /* __MACH_IOMMU_H */