xref: /freebsd-11.0-release/sys/boot/uboot/lib/glue.h

/*-
 * Copyright (c) 2008 Semihalf, Rafal Jaworowski <raj@semihalf.com>
 * 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 AUTHOR 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 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.
 *
 * $FreeBSD: releng/11.0/sys/boot/uboot/lib/glue.h 296564 2016-03-09 11:45:48Z sgalabov $
 */

/*
 * This is the header file for conveniency wrapper routines (API glue)
 */

#ifndef _API_GLUE_H_
#define _API_GLUE_H_

#include "api_public.h"

/*
 * Mask used to align the start address for API signature search to 1MiB
 */
#define	API_SIG_SEARCH_MASK	~0x000fffff

#ifdef __mips__
/*
 * On MIPS, U-Boot passes us a hint address, which is very close to the end of
 * RAM (less than 1MiB), so searching for the API signature within more than
 * that leads to exception.
 */
#define	API_SIG_SEARCH_LEN	0x00100000
#else
/*
 * Search for the API signature within 3MiB of the 1MiB-aligned address that
 * U-Boot has hinted us.
 */
#define	API_SIG_SEARCH_LEN	0x00300000
#endif

int syscall(int, int *, ...);
void *syscall_ptr;

int api_parse_cmdline_sig(int argc, char **argv, struct api_signature **sig);
int api_search_sig(struct api_signature **sig);

#define	UB_MAX_MR	16		/* max mem regions number */
#define	UB_MAX_DEV	6		/* max devices number */

/*
 * The ub_ library calls are part of the application, not U-Boot code!  They
 * are front-end wrappers that are used by the consumer application: they
 * prepare arguments for particular syscall and jump to the low level
 * syscall()
 */

/* console */
int ub_getc(void);
int ub_tstc(void);
void ub_putc(char);
void ub_puts(const char *);

/* system */
void ub_reset(void);
struct sys_info *ub_get_sys_info(void);

/* time */
void ub_udelay(unsigned long);
unsigned long ub_get_timer(unsigned long);

/* env vars */
char *ub_env_get(const char *);
void ub_env_set(const char *, char *);
const char *ub_env_enum(const char *);

/* devices */
int ub_dev_enum(void);
int ub_dev_open(int);
int ub_dev_close(int);
int ub_dev_read(int, void *, lbasize_t, lbastart_t, lbasize_t *);
int ub_dev_send(int, void *, int);
int ub_dev_recv(int, void *, int, int *);
struct device_info *ub_dev_get(int);

void ub_dump_di(int);
void ub_dump_si(struct sys_info *);
char *ub_mem_type(int);
char *ub_stor_type(int);

#endif /* _API_GLUE_H_ */