/*      $NetBSD: octeon_fauvar.h,v 1.4 2020/06/23 05:14:18 simonb Exp $ */

/*
 * Copyright (c) 2007 Internet Initiative Japan, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.
 */

#ifndef _OCTEON_FAUVAR_H_
#define _OCTEON_FAUVAR_H_

#include <mips/cavium/octeonreg.h>

/* ---- API */

struct octfau_desc {
        /* offset in scratch buffer */
        size_t          fd_scroff;      /* XXX offset_t */
        /* FAU register number */
        size_t          fd_regno;       /* XXX offset_t */
};

void            octfau_op_init(struct octfau_desc *, size_t, size_t);
uint64_t        octfau_op_save(struct octfau_desc *);
void            octfau_op_restore(struct octfau_desc *, uint64_t);
int64_t         octfau_op_inc_8(struct octfau_desc *, int64_t);
int32_t         octfau_op_inc_4(struct octfau_desc *, int32_t);
int16_t         octfau_op_inc_2(struct octfau_desc *, int16_t);
int8_t          octfau_op_inc_1(struct octfau_desc *, int8_t);
int64_t         octfau_op_incwait_8(struct octfau_desc *, int);
int32_t         octfau_op_incwait_4(struct octfau_desc *, int);
int16_t         octfau_op_incwait_2(struct octfau_desc *, int);
int8_t          octfau_op_incwait_1(struct octfau_desc *, int);
int64_t         octfau_op_get_8(struct octfau_desc *);
int32_t         octfau_op_get_4(struct octfau_desc *);
int16_t         octfau_op_get_2(struct octfau_desc *);
int8_t          octfau_op_get_1(struct octfau_desc *);
int64_t         octfau_op_getwait_8(struct octfau_desc *);
int32_t         octfau_op_getwait_4(struct octfau_desc *);
int16_t         octfau_op_getwait_2(struct octfau_desc *);
int8_t          octfau_op_getwait_1(struct octfau_desc *);
void            octfau_op_add_8(struct octfau_desc *, int64_t);
void            octfau_op_add_4(struct octfau_desc *, int32_t);
void            octfau_op_add_2(struct octfau_desc *, int16_t);
void            octfau_op_add_1(struct octfau_desc *, int8_t);
void            octfau_op_set_8(struct octfau_desc *, int64_t);
void            octfau_op_set_4(struct octfau_desc *, int32_t);
void            octfau_op_set_2(struct octfau_desc *, int16_t);
void            octfau_op_set_1(struct octfau_desc *, int8_t);

/* ---- old API */

/* XXX */
#define OCT_FAU_REG_OQ_ADDR_INDEX (0)
#define OCT_FAU_REG_ADDR_END (256)
/* XXX */

/* XXX */
typedef enum {
        OCT_FAU_OP_SIZE_8  = 0,
        OCT_FAU_OP_SIZE_16 = 1,
        OCT_FAU_OP_SIZE_32 = 2,
        OCT_FAU_OP_SIZE_64 = 3
} fau_op_size_t;
/* XXX */

/*
 * XXX
 * `scraddr' parameter of IOBDMA operation is actually `index';
 */
static inline void
octfau_op_iobdma(int index, uint64_t args)
{
        uint64_t value = IOBDMA_CREATE(FAU_MAJOR_DID, FAU_SUB_DID,
            index, POW_IOBDMA_LEN, args);

        octeon_iobdma_write_8(value);
}

/* IOBDMA Operations */

/* IOBDMA Store Data for FAU Operations */

static inline void
octfau_op_iobdma_store_data(int scraddr, int incval, int tagwait,
    int size, int reg)
{
        uint64_t args =
            __SHIFTIN(incval, POW_IOBDMA_INCVAL) |
            __SHIFTIN(tagwait, POW_IOBDMA_TAGWAIT) |
            __SHIFTIN(size, POW_IOBDMA_SIZE) |
            __SHIFTIN(reg, POW_IOBDMA_REG);

        /* `scraddr' parameter of IOBDMA operation is actually `index' */
        octfau_op_iobdma(scraddr / sizeof(uint64_t), args);
}

static inline void
octfau_op_inc_fetch_8(struct octfau_desc *fd, int64_t v)
{

        octfau_op_iobdma_store_data(fd->fd_scroff, v, 0,
            OCT_FAU_OP_SIZE_64/* XXX */, fd->fd_regno);
}

static inline int64_t
octfau_op_inc_read_8(struct octfau_desc *fd)
{

        OCTEON_SYNCIOBDMA;
        return octeon_cvmseg_read_8(fd->fd_scroff);
}

#endif /* _OCTEON_FAUVAR_H_ */