root/sys/arch/arm/arm/cpufunc_asm_armv5.S
/*      $NetBSD: cpufunc_asm_armv5.S,v 1.9 2022/10/20 06:58:38 skrll Exp $      */

/*
 * Copyright (c) 2002, 2005 ARM Limited
 * 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.
 * 3. The name of the company may not be used to endorse or promote
 *    products derived from this software without specific prior written
 *    permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.
 *
 * ARMv5 assembly functions for manipulating caches.
 * These routines can be used by any core that supports the set/index
 * operations.
 */

#include "assym.h"
#include <machine/asm.h>
#include <arm/locore.h>

/*
 * Functions to set the MMU Translation Table Base register
 *
 * We need to clean and flush the cache as it uses virtual
 * addresses that are about to change.
 */
ENTRY(armv5_setttb)
        cmp     r1, #0
        beq     1f

        stmfd   sp!, {r0, lr}
        bl      _C_LABEL(armv5_idcache_wbinv_all)
        ldmfd   sp!, {r0, lr}
        cmp     r0, #1

1:      mcr     p15, 0, r0, c2, c0, 0   /* load new TTB */
        mcrne   p15, 0, r0, c8, c7, 0   /* invalidate I+D TLBs */
        RET

/*
 * Cache operations.  For the entire cache we use the set/index
 * operations.
 */
        s_max   .req r0
        i_max   .req r1
        s_inc   .req r2
        i_inc   .req r3

ENTRY_NP(armv5_icache_sync_range)
        ldr     ip, .Larmv5_line_size
        cmp     r1, #0x4000
        bcs     .Larmv5_icache_sync_all
        ldr     ip, [ip]
        sub     r1, r1, #1              /* Don't overrun */
        sub     r3, ip, #1
        and     r2, r0, r3
        add     r1, r1, r2
        bic     r0, r0, r3
1:
        mcr     p15, 0, r0, c7, c5, 1   /* Invalidate I cache SE with VA */
        mcr     p15, 0, r0, c7, c10, 1  /* Clean D cache SE with VA */
        add     r0, r0, ip
        subs    r1, r1, ip
        bpl     1b
        mcr     p15, 0, r0, c7, c10, 4  /* drain the write buffer */
        RET

ENTRY_NP(armv5_icache_sync_all)
.Larmv5_icache_sync_all:
        /*
         * We assume that the code here can never be out of sync with the
         * dcache, so that we can safely flush the Icache and fall through
         * into the Dcache cleaning code.
         */
        mcr     p15, 0, r0, c7, c5, 0   /* Flush I cache */
        /* Fall through to clean Dcache. */

.Larmv5_dcache_wb:
        ldr     ip, .Larmv5_cache_data
        ldmia   ip, {s_max, i_max, s_inc, i_inc}
1:
        orr     ip, s_max, i_max
2:
        mcr     p15, 0, ip, c7, c10, 2  /* Clean D cache SE with Set/Index */
        sub     ip, ip, i_inc
        tst     ip, i_max               /* Index 0 is last one */
        bne     2b                      /* Next index */
        mcr     p15, 0, ip, c7, c10, 2  /* Clean D cache SE with Set/Index */
        subs    s_max, s_max, s_inc
        bpl     1b                      /* Next set */
        mcr     p15, 0, r0, c7, c10, 4  /* drain the write buffer */
        RET

.Larmv5_line_size:
        .word   _C_LABEL(arm_pcache) + DCACHE_LINE_SIZE

ENTRY(armv5_dcache_wb_range)
        ldr     ip, .Larmv5_line_size
        cmp     r1, #0x4000
        bcs     .Larmv5_dcache_wb
        ldr     ip, [ip]
        sub     r1, r1, #1              /* Don't overrun */
        sub     r3, ip, #1
        and     r2, r0, r3
        add     r1, r1, r2
        bic     r0, r0, r3
1:
        mcr     p15, 0, r0, c7, c10, 1  /* Clean D cache SE with VA */
        add     r0, r0, ip
        subs    r1, r1, ip
        bpl     1b
        mcr     p15, 0, r0, c7, c10, 4  /* drain the write buffer */
        RET

ENTRY(armv5_dcache_wbinv_range)
        ldr     ip, .Larmv5_line_size
        cmp     r1, #0x4000
        bcs     .Larmv5_dcache_wbinv_all
        ldr     ip, [ip]
        sub     r1, r1, #1              /* Don't overrun */
        sub     r3, ip, #1
        and     r2, r0, r3
        add     r1, r1, r2
        bic     r0, r0, r3
1:
        mcr     p15, 0, r0, c7, c14, 1  /* Purge D cache SE with VA */
        add     r0, r0, ip
        subs    r1, r1, ip
        bpl     1b
        mcr     p15, 0, r0, c7, c10, 4  /* drain the write buffer */
        RET

/*
 * Note, we must not invalidate everything.  If the range is too big we
 * must use wb-inv of the entire cache.
 */
ENTRY(armv5_dcache_inv_range)
        ldr     ip, .Larmv5_line_size
        cmp     r1, #0x4000
        bcs     .Larmv5_dcache_wbinv_all
        ldr     ip, [ip]
        sub     r1, r1, #1              /* Don't overrun */
        sub     r3, ip, #1
        and     r2, r0, r3
        add     r1, r1, r2
        bic     r0, r0, r3
1:
        mcr     p15, 0, r0, c7, c6, 1   /* Invalidate D cache SE with VA */
        add     r0, r0, ip
        subs    r1, r1, ip
        bpl     1b
        mcr     p15, 0, r0, c7, c10, 4  /* drain the write buffer */
        RET

ENTRY(armv5_idcache_wbinv_range)
        ldr     ip, .Larmv5_line_size
        cmp     r1, #0x4000
        bcs     .Larmv5_idcache_wbinv_all
        ldr     ip, [ip]
        sub     r1, r1, #1              /* Don't overrun */
        sub     r3, ip, #1
        and     r2, r0, r3
        add     r1, r1, r2
        bic     r0, r0, r3
1:
        mcr     p15, 0, r0, c7, c5, 1   /* Invalidate I cache SE with VA */
        mcr     p15, 0, r0, c7, c14, 1  /* Purge D cache SE with VA */
        add     r0, r0, ip
        subs    r1, r1, ip
        bpl     1b
        mcr     p15, 0, r0, c7, c10, 4  /* drain the write buffer */
        RET

ENTRY_NP(armv5_idcache_wbinv_all)
.Larmv5_idcache_wbinv_all:
        /*
         * We assume that the code here can never be out of sync with the
         * dcache, so that we can safely flush the Icache and fall through
         * into the Dcache purging code.
         */
        mcr     p15, 0, r0, c7, c5, 0   /* Flush I cache */
        /* Fall through to purge Dcache. */

ENTRY(armv5_dcache_wbinv_all)
.Larmv5_dcache_wbinv_all:
        ldr     ip, .Larmv5_cache_data
        ldmia   ip, {s_max, i_max, s_inc, i_inc}
1:
        orr     ip, s_max, i_max
2:
        mcr     p15, 0, ip, c7, c14, 2  /* Purge D cache SE with Set/Index */
        sub     ip, ip, i_inc
        tst     ip, i_max               /* Index 0 is last one */
        bne     2b                      /* Next index */
        mcr     p15, 0, ip, c7, c14, 2  /* Purge D cache SE with Set/Index */
        subs    s_max, s_max, s_inc
        bpl     1b                      /* Next set */
        mcr     p15, 0, r0, c7, c10, 4  /* drain the write buffer */
        RET

.Larmv5_cache_data:
        .word   _C_LABEL(armv5_dcache_sets_max)

        .bss

/* XXX The following macros should probably be moved to asm.h */
#define _DATA_OBJECT(x) .globl x; .type x,_ASM_TYPE_OBJECT; x:
#define C_OBJECT(x)     _DATA_OBJECT(_C_LABEL(x))

/*
 * Parameters for the cache cleaning code.  Note that the order of these
 * four variables is assumed in the code above.  Hence the reason for
 * declaring them in the assembler file.
 */
        .align 0
C_OBJECT(armv5_dcache_sets_max)
        .space  4
C_OBJECT(armv5_dcache_index_max)
        .space  4
C_OBJECT(armv5_dcache_sets_inc)
        .space  4
C_OBJECT(armv5_dcache_index_inc)
        .space  4