Newer
Older
ubixos / src / sys / include / ubixfs / ubixfs.h
@reddawg reddawg on 21 May 2004 4 KB Cleaned up
/*****************************************************************************************
 Copyright (c) 2002-2004 The UbixOS Project
 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, the following disclaimer and the list of authors.  Redistributions in binary
 form must reproduce the above copyright notice, this list of conditions, the following
 disclaimer and the list of authors in the documentation and/or other materials provided
 with the distribution. Neither the name of the UbixOS 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.

 $Id$

*****************************************************************************************/

#ifndef _UBIXFS_H
#define _UBIXFS_H

#include <ubixos/types.h>
#include <sys/device.h>
#include <vfs/file.h>

#define UBIXDISKMAGIC     ((uInt32)0x45) /* The disk magic number */
#define MAXPARTITIONS     4
#define blockSize         8
#define blockByteSize     blockSize*512

#define EOBC              -1


#define typeFile      1
#define typeContainer 2
#define typeDirectory 4
#define typeDeleted   8

/// Partition Information
struct ubixDiskLabel {
  uInt32 magicNum;
  uInt32 magicNum2;
  uInt16 driveType;
  uInt16 numPartitions;
  struct  drivePartitions {  /// the partition table
    uInt32 pSize;            /// number of sectors in partition
    uInt32 pOffset;          /// starting sector
    uInt32 pFsSize;          /// filesystem basic fragment size
    uInt32 pBatSize;         /// BAT size
    uInt8  pFsType;          /// filesystem type, see below
    uInt8 pFrag;            /// filesystem fragments per block
    } partitions[MAXPARTITIONS];
  };

struct partitionInformation {
  uInt32 size;                 /// Size In Sectors
  uInt32 startSector;          /// Base Sector Of Partition
  uInt32 blockAllocationTable; /// Base Sector Of BAT
  uInt32 rootDirectory;        /// Base Sector Of Root Directory
  };

/// Block Allocation Table Entry
struct blockAllocationTableEntry {
  long attributes; /// Block Attributes
  long realSector; /// Real Sector  
  long nextBlock;  /// Sector Of Next Block
  long reserved;   /// Reserved
  };

/// UbixFS Directory Entry
struct directoryEntry {
  uInt32  startCluster;   /// Starting Cluster Of File
  uInt32  size;           /// Size Of File
  uInt32  creationDate;  /// Date Created
  uInt32  lastModified;  /// Date Last Modified
  uInt32  uid;           /// UID Of Owner
  uInt32  gid;           /// GID Of Owner
  uInt16 attributes;    /// Files Attributes
  uInt16 permissions;   /// Files Permissions
  char   fileName[256]; /// File Name
};

/// Bootsector structure
struct bootSect {
  uInt8 jmp[4];
  uInt8 id[6];
  uInt16 version;
  uInt16 tmp;
  uInt16 fsStart;
  uInt16 tmp2;
  uInt32 krnl_start;
  uInt BytesPerSector;
  uInt SectersPerTrack;
  uInt TotalHeads;
  uInt32 TotalSectors;
  uInt8 code[479];
  };  

struct ubixFsInfo {
  struct blockAllocationTableEntry *blockAllocationTable;
  uInt32 batEntries;
  };

/**  Registers UbixFS functions with the virtual file-system (using vfsRegisterFS). Returns 1 if a failure
 happened, and 0 if success. */
int readFile(char *file);

/** Sets up the Ubix filesystem with appropriate data. If the medium is a hard-drive (or any medium?), it looks
 in the partition table. */
int writeFileByte(int ch,fileDescriptor *fd,long offset);
int openFileUbixFS(char *file,fileDescriptor *fd);
int mkDirUbixFS(char *dir,fileDescriptor *fd);
int getFreeBlocks(int count,fileDescriptor *fd);
//extern struct ubixDiskLabel *diskLabel;

//Good Functions
void initUbixFS(struct mountPoints *mp);
int enableUbixFS();
int readUbixFS(fileDescriptor *fd,char *data,long offset,long size);
int writeUbixFS(fileDescriptor *fd,char *data,long offset,long size);
void syncBat(struct mountPoints *mp);
int freeBlocks(int block,fileDescriptor *fd);
int addDirEntry(struct directoryEntry *dir,fileDescriptor *fd);
void ubixFSUnlink(char *path,struct mountPoints *mp);

#endif

/***
 $Log$

 END
 ***/