/*      $NetBSD: asm.h,v 1.2 2015/03/27 06:57:21 matt Exp $     */

/*-
 * Copyright (c) 2014 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Matt Thomas of 3am Software Foundry.
 *
 * 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 NETBSD FOUNDATION, INC. 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 FOUNDATION 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 _RISCV_ASM_H
#define _RISCV_ASM_H

#define _C_LABEL(x)     x

/*
 * Define -pg profile entry code.
 * Must always be noreorder, must never use a macro instruction
 * Final addiu to t9 must always equal the size of this _KERN_MCOUNT
 */
#define _KERN_MCOUNT                                            \
        .set    push;                                           \
        subi    sp, sp, CALLFRAME_SIZE;                         \
        REG_S   a0, CALLFRAME_S0(sp);                           \
        REG_S   ra, CALLFRAME_RA(sp);                           \
        move    a0, ra;                                         \
        call    _mcount                                         \
        REG_L   ra, CALLFRAME_RA(sp);                           \
        REG_L   a0, CALLFRAME_S0(sp);                           \
        addi    sp, sp, CALLFRAME_SIZ;                          \
        .set    pop;                                    

#ifdef GPROF
#define _PROF_PROLOGUE _KERN_MCOUNT
#else
#define _PROF_PROLOGUE
#endif

#ifdef __PIC__
#define PLT(x)  x##@
#else
#define PLT(x)  x
#endif

/*
 * WEAK_ALIAS: create a weak alias.
 */
#define WEAK_ALIAS(alias,sym)                                           \
        .weak alias;                                                    \
        alias = sym
/*
 * STRONG_ALIAS: create a strong alias.
 */
#define STRONG_ALIAS(alias,sym)                                         \
        .globl alias;                                                   \
        alias = sym

/*
 * WARN_REFERENCES: create a warning if the specified symbol is referenced.
 */
#define WARN_REFERENCES(sym,msg)                                        \
        .pushsection __CONCAT(.gnu.warning.,sym);                       \
        .ascii msg;                                                     \
        .popsection

#define _ENTRY(x)                       \
        .globl  _C_LABEL(x);            \
        .type   _C_LABEL(x), @function; \
        _C_LABEL(x):

#define ENTRY_NP(x)     .text; .align 2; _ENTRY(x)
#define ENTRY(x)        ENTRY_NP(x); _PROF_PROLOGUE
#define END(x)          .size _C_LABEL(x), . - _C_LABEL(x)

/*
 * Macros to panic and printf from assembly language.
 */
#define PANIC(msg)                      \
        la      a0, 9f;                 \
        call    _C_LABEL(panic);        \
        MSG(msg)

#define PRINTF(msg)                     \
        la      a0, 9f;                 \
        call    _C_LABEL(printf);       \
        MSG(msg)

#define MSG(msg)                        \
        .pushsection .rodata.str1.8,"aMS",@progbits,1; \
9:      .asciiz msg;                    \
        .popsection

#define ASMSTR(str)                     \
        .asciiz str;                    \
        .align  3

#define __RCSID(name)   .pushsection ".ident"; .asciz name; .popsection
#define RCSID(name)     __RCSID(name)

#if defined(_LP64)
#define SZREG   8
#else
#define SZREG   4
#endif

#define ALSK    15              /* stack alignment */
#define ALMASK  -15             /* stack alignment */
#define SZFPREG 8
#define FP_L    fld
#define FP_S    fsd

/*
 *  standard callframe {
 *      register_t cf_sp;               frame pointer
 *      register_t cf_ra;               return address
 *  };
 */
#define CALLFRAME_SIZ   (SZREG * 4)
#define CALLFRAME_S1    (CALLFRAME_SIZ - 4 * SZREG)
#define CALLFRAME_S0    (CALLFRAME_SIZ - 3 * SZREG)
#define CALLFRAME_SP    (CALLFRAME_SIZ - 2 * SZREG)
#define CALLFRAME_RA    (CALLFRAME_SIZ - 1 * SZREG)

/*
 * These macros hide the use of rv32 and rv64 instructions from the
 * assembler to prevent the assembler from generating 64-bit style
 * ABI calls.
 */
#define PTR_ADD         add
#define PTR_ADDI        addi
#define PTR_SUB         sub
#define PTR_SUBI        subi
#define PTR_LA          la
#define PTR_SLLI        slli
#define PTR_SLL         sll
#define PTR_SRLI        srli
#define PTR_SRL         srl
#define PTR_SRAI        srai
#define PTR_SRA         sra
#if _LP64
#define PTR_L           ld
#define PTR_S           sd
#define PTR_LR          lr.d
#define PTR_SC          sc.d
#define PTR_WORD        .dword
#define PTR_SCALESHIFT  3
#else
#define PTR_L           lw
#define PTR_S           sw
#define PTR_LR          lr.w
#define PTR_SC          sc.w
#define PTR_WORD        .word
#define PTR_SCALESHIFT  2
#endif

#define INT_L           lw
#define INT_LA          la
#define INT_S           sw
#define INT_LR          lr.w
#define INT_SC          sc.w
#define INT_WORD        .word
#define INT_SCALESHIFT  2
#ifdef _LP64
#define INT_ADD         addw
#define INT_ADDI        addwi
#define INT_SUB         subw
#define INT_SUBI        subwi
#define INT_SLL         sllwi
#define INT_SLLV        sllw
#define INT_SRL         srlwi
#define INT_SRLV        srlw
#define INT_SRA         srawi
#define INT_SRAV        sraw
#else
#define INT_ADD         add
#define INT_ADDI        addi
#define INT_SUB         sub
#define INT_SUBI        subi
#define INT_SLLI        slli
#define INT_SLL         sll
#define INT_SRLI        srli
#define INT_SRL         srl
#define INT_SRAI        srai
#define INT_SRA         sra
#endif

#define LONG_LA         la
#define LONG_ADD        add
#define LONG_ADDI       addi
#define LONG_SUB        sub
#define LONG_SUBI       subi
#define LONG_SLLI       slli
#define LONG_SLL        sll
#define LONG_SRLI       srli
#define LONG_SRL        srl
#define LONG_SRAI       srai
#define LONG_SRA        sra
#ifdef _LP64
#define LONG_L          ld
#define LONG_S          sd
#define LONG_LR         lr.d
#define LONG_SC         sc.d
#define LONG_WORD       .quad
#define LONG_SCALESHIFT 3
#else
#define LONG_L          lw
#define LONG_S          sw
#define LONG_LR         lr.w
#define LONG_SC         sc.w
#define LONG_WORD       .word
#define LONG_SCALESHIFT 2
#endif

#define REG_LI          li
#define REG_ADD         add
#define REG_SLLI        slli
#define REG_SLL         sll
#define REG_SRLI        srli
#define REG_SRL         srl
#define REG_SRAI        srai
#define REG_SRA         sra
#if _LP64
#define REG_L           ld
#define REG_S           sd
#define REG_LR          lr.d
#define REG_SC          sc.d
#define REG_SCALESHIFT  3
#else
#define REG_L           lw
#define REG_S           sw
#define REG_LR          lr.w
#define REG_SC          sc.w
#define REG_SCALESHIFT  2
#endif

#define CPUVAR(off) _C_LABEL(cpu_info_store)+__CONCAT(CPU_INFO_,off)

#endif /* _RISCV_ASM_H */