/*
 * Copyright (c) 2025 Ian Marco Moffett and L5 engineers
 * 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. Neither the name of the project 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 OWNER 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 _CONS_CONS_H_
#define _CONS_CONS_H_ 1

#include <sys/types.h>
#include <sys/bootvars.h>
#include <os/spinlock.h>

struct cons_scr {
    struct spinlock lock;
    struct bootvar_fb fbvars;
    size_t text_x;
    size_t text_y;
    size_t max_col;
    uint32_t scr_bg;
    uint32_t scr_fg;
};

/*
 * Represents the root screen used during
 * early boot of the system.
 */
extern struct cons_scr g_root_scr;

/*
 * Initialize the console to a basic working
 * state.
 */
int cons_init(void);

/*
 * Write a string onto the screen
 *
 * @scr: Screen to write on
 * @str: String to write onto the screen
 * @len: Length of string to write
 *
 * Returns the number of bytes written on success,
 * otherwise a less than zero value to indicate failure.
 */
ssize_t cons_putstr(struct cons_scr *scr, const char *str, size_t len);

#endif  /* !_CONS_CONS_H_ */