/* Calcite, include/kernel-public/files.h
 * Copyright 2025 Benji Dial
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
 * for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program. If not, see <https://www.gnu.org/licenses/>.
 */

#pragma once

#include <stdint.h>

enum fs_access_result {
  FAR_SUCCESS,
  FAR_HARDWARE_ERROR,
  FAR_FORMAT_ERROR,
  FAR_UNKNOWN_FS_TYPE,
  FAR_NOT_FOUND,
  FAR_OUT_OF_BOUNDS,
  FAR_BAD_HANDLE
};

typedef uint64_t file_handle_t;

struct read_file_parameter {
  file_handle_t handle;
  void *buffer;
  //in bytes
  uint64_t start;
  uint64_t bytes;
};