/*
 * Copyright (c) 2021, RISC OS Open Ltd
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * 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.
 *     * Neither the name of RISC OS Open Ltd nor the names of its contributors
 *       may be used to endorse or promote products derived from this software
 *       without specific prior written permission.
 *
 * 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.
 */
#ifndef KERNELIFACE_H
#define KERNELIFACE_H

#include <stdbool.h>
#include <stdint.h>
#include "kernel.h"

/* Assorted things exported by the (assembler) parts of the kernel for
   use by other kernel code */

/* ZeroPage variables */

extern uint32_t g_ProcessorFlags; /* OS_PlatformFeatures 0 */

/* Errors */
extern const _kernel_oserror ErrorBlock_BadParameters;

extern _kernel_oserror *TranslateError(_kernel_oserror const *e);

/* void *kalloc (size_t size, _kernel_oserror **e)
   It's malloc, but it stores any received error in 'e'.
   'e' is only written to if there's an error, so you can make several calls
   using just one _kernel_oserror *. */
extern void *kalloc(size_t size,_kernel_oserror **e);

typedef struct {
	uint64_t phys; /* -1 if invalid address */
	uint32_t pageflags; /* -1 if invalid address */
	uint32_t size;
} log2phys_result;

extern __value_in_regs log2phys_result RISCOS_LogToPhys(const void *log);

typedef struct {
	uint32_t flags;
	int32_t ap;
	uint32_t permissions;
} MemoryAccessPrivileges_result;

extern __value_in_regs MemoryAccessPrivileges_result MemoryAccessPrivileges(uint32_t seventeen,int32_t ap);

static inline uint32_t AP_To_Permissions(int32_t ap)
{
	return MemoryAccessPrivileges(17,ap).permissions;
}

#endif