/*
 * Copyright (C) 2012 Red Hat, Inc. All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * author: Jerome Glisse
 */
#ifndef RDB_H
#define RDB_H

#include "list.h"

/* Domain 0x0 through 0x100 are reserved for predefined domain
 * such as MMIO, PIO, PCI, PCIE register address space.
 */
#define RDB_DOMAIN_MMIO                 0x0000
#define RDB_DOMAIN_PIO                  0x0001
#define RDB_DOMAIN_PCI                  0x0002  /* clock */
#define RDB_DOMAIN_PCIE                 0x0003  /* GPU dma controller */

struct rdb {
    struct list_head    blocks;
    struct list_head    domains;
    struct list_head    its;
    struct list_head    ranges;
    struct list_head    regs;
};

struct rdb_block {
    struct list_head    list;
    unsigned            id;
    char                *name;
    char                *description;
};

struct rdb_domain {
    struct list_head    list;
    unsigned            id;
    char                *name;
    char                *description;
};


struct rdb_field {
    struct list_head    list;
    unsigned            shift;
    unsigned            mask;
    unsigned            dvalue;
    unsigned            rw;
    char                *name;
    char                *description;
    struct list_head    values;
};

struct rdb_it {
    struct list_head    list;
    unsigned            it;
    char                *name;
    char                *description;
};

struct rdb_range {
    struct list_head    list;
    unsigned            domain;
    unsigned            soffset;
    unsigned            eoffset;
    char                *name;
    char                *description;
};

struct rdb_reg {
    struct list_head    list;
    unsigned            block;
    unsigned            domain;
    unsigned            offset;
    unsigned            size;
    /* base represent the starting id value to use in name for repeating register */
    unsigned            base;
    unsigned            nrepeat;
    unsigned            stride;
    char                *name;
    char                *description;
    struct list_head    fields;
};

struct rdb_value {
    struct list_head    list;
    unsigned            value;
    char                *name;
    char                *description;
};

void rdb_init(struct rdb *rdb);
int rdb_read(struct rdb *rdb, FILE *file);
void rdb_write(FILE *file, struct rdb *rdb);
const struct rdb_reg *rdb_find_reg(struct rdb *rdb, unsigned domain, unsigned offset);
const struct rdb_reg *rdb_find_reg_any_domain(struct rdb *rdb, unsigned offset);

#endif