fat32.c File Reference

#include "fat32.h"
#include "../../drivers/blk/block.h"
#include "../../assert.h"
#include "../../time.h"
#include "../../intrinsics/atomic.h"
#include "../../includes/mg.h"
#include "../../includes/mm.h"

Go to the source code of this file.

Data Structures
struct	LFN_ENTRY_BUFFER

Macros
#define	WRITE_MODE_APPEND_EXISTING   0
#define	WRITE_MODE_CREATE_OR_REPLACE   1
#define	le32toh(x)
#define	MAX_LFN_ENTRIES   20
#define	MAX_LFN_LEN   260
#define	FAT32_READ_ERROR   0xFFFFFFFFu
#define	BPB_SECTOR_START   2048

Functions
MTSTATUS	fat32_init (int disk_index)
void	fat32_list_root (void)
MTSTATUS	fat32_read_file (const char *filename, uint32_t *file_size_out, void **buffer_out)
	A FAT32 Function that reads the file requested into a dynamically allocated buffer.
MTSTATUS	fat32_create_directory (const char *path)
	Creates a new directory (/testdir/ or /testdir are both allowed to create 'testdir' inside of 'root')
MTSTATUS	fat32_write_file (const char *path, const void *data, uint32_t size, uint32_t mode)
	Creates a new file and writes data to it.
MTSTATUS	fat32_list_directory (const char *path, char *listings, size_t max_len)
	Lists the directory given.
bool	fat32_directory_is_empty (const char *path)
	This function returns if the directory given to the function is empty (e.g, has only '.' and '..' entries / deleted / nonexistent)
MTSTATUS	fat32_delete_directory (const char *path)
	This function deletes the directory given to the function from the system.
MTSTATUS	fat32_delete_file (const char *path)
	This function deletes the file given to the function from the system.

Variables
GOP_PARAMS	gop_local
void *	fat_cache_buf2 = NULL
volatile int32_t	fat32_called_from_scanner = 0

Macro Definition Documentation

BPB_SECTOR_START

#define BPB_SECTOR_START   2048

Definition at line 742 of file fat32.c.

FAT32_READ_ERROR

#define FAT32_READ_ERROR   0xFFFFFFFFu

Definition at line 41 of file fat32.c.

le32toh

#define le32toh

(

x

)

Value:

(x)

Definition at line 21 of file fat32.c.

MAX_LFN_ENTRIES

#define MAX_LFN_ENTRIES   20

Definition at line 35 of file fat32.c.

MAX_LFN_LEN

#define MAX_LFN_LEN   260

Definition at line 36 of file fat32.c.

WRITE_MODE_APPEND_EXISTING

#define WRITE_MODE_APPEND_EXISTING   0

Definition at line 15 of file fat32.c.

WRITE_MODE_CREATE_OR_REPLACE

#define WRITE_MODE_CREATE_OR_REPLACE   1

Definition at line 16 of file fat32.c.

Function Documentation

fat32_create_directory()

MTSTATUS fat32_create_directory

(

const char *

path

)

Creates a new directory (/testdir/ or /testdir are both allowed to create 'testdir' inside of 'root')

Parameters

path	The full path to the new directory

Returns

MTSTATUS Status code.

Definition at line 1047 of file fat32.c.

fat32_delete_directory()

MTSTATUS fat32_delete_directory

(

const char *

path

)

This function deletes the directory given to the function from the system.

Parameters

path	Full path to delete directory.

Returns

MTSTATUS Status code.

Definition at line 1922 of file fat32.c.

fat32_delete_file()

MTSTATUS fat32_delete_file

(

const char *

path

)

This function deletes the file given to the function from the system.

Parameters

path	Full path to delete file.

Returns

MTSTATUS Status code.

Definition at line 1954 of file fat32.c.

fat32_directory_is_empty()

bool fat32_directory_is_empty

(

const char *

path

)

This function returns if the directory given to the function is empty (e.g, has only '.' and '..' entries / deleted / nonexistent)

Parameters

path	Full path to dir

Returns

True or false based if empty or not.

Definition at line 1663 of file fat32.c.

fat32_init()

MTSTATUS fat32_init

(

int

disk_index

)

Definition at line 745 of file fat32.c.

fat32_list_directory()

MTSTATUS fat32_list_directory	(	const char *	path,
		char *	listings,
		size_t	max_len )

Lists the directory given.

Parameters

path	Path to directory, e.g "mydir/"
listings	[OUT] Pointer to directory listing. (each seperated with a newline character)
max_len	[IN] Max size of listings buffer.

Returns

MTSTATUS Status code.

Definition at line 1579 of file fat32.c.

fat32_list_root()

void fat32_list_root

(

void

)

Definition at line 769 of file fat32.c.

fat32_read_file()

MTSTATUS fat32_read_file	(	const char *	filename,
		uint32_t *	file_size_out,
		void **	buffer_out )

A FAT32 Function that reads the file requested into a dynamically allocated buffer.

Parameters

filename	The Filename to read, e.g "file.txt" or "tmp/folder/myfile.txt"
file_size_out	A pointer to put the file size in bytes
bufferOut	A pointer to put the file buffer in (doesn't need to be dynamically allocated)

Returns

MTSTATUS Status Code.

Definition at line 921 of file fat32.c.

fat32_write_file()

MTSTATUS fat32_write_file	(	const char *	path,
		const void *	data,
		uint32_t	size,
		uint32_t	file_modification_mode )

Creates a new file and writes data to it.

Parameters

path	The full path of the file to create
data	A pointer to the data to write.
size	The number of bytes to write
file_modification_mode	Whether to APPEND or REPLACE the file. (in FS_WRITE_MODES enum)

Returns

MTSTATUS Status code.

Definition at line 1275 of file fat32.c.

Variable Documentation

fat32_called_from_scanner

volatile int32_t fat32_called_from_scanner = 0

Definition at line 38 of file fat32.c.

fat_cache_buf2

void* fat_cache_buf2 = NULL

Definition at line 32 of file fat32.c.

gop_local

GOP_PARAMS gop_local

extern

Definition at line 26 of file kernel.c.