FileSystemObject.hpp

Go to the documentation of this file.

/*
 *     SocialLedge.com - Copyright (C) 2013
 *
 *     This file is part of free software framework for embedded processors.
 *     You can use it and/or distribute it as long as this copyright header
 *     remains unmodified.  The code is free for personal use and requires
 *     permission to use in a commercial product.
 *
 *      THIS SOFTWARE IS PROVIDED "AS IS".  NO WARRANTIES, WHETHER EXPRESS, IMPLIED
 *      OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF
 *      MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE.
 *      I SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, OR
 *      CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.
 *
 *     You can reach the author of this software at :
 *          p r e e t . w i k i @ g m a i l . c o m
 */

#ifndef FILE_SYSTEM_OBJ_HPP__
#define FILE_SYSTEM_OBJ_HPP__

#include "fat/ff.h"
#include "fat/disk/diskio.h"



class FileSystemObject
{
    public:
        const char* getDrivePath() const
        {
            return mVolStr;
        }

        char mount() const
        {
            return f_mount((FATFS*)&mFileSystem, getDrivePath(), 1);
        }

        FRESULT getDriveInfo(unsigned int* pTotalDriveSpaceKB, unsigned int* pAvailableSpaceKB) const
        {
            // This object will just point back to our mFileSystem using the mVolStr
            FATFS* pFatFs;

            *pTotalDriveSpaceKB = 0;
            *pAvailableSpaceKB = 0;
            unsigned long int fre_clust = 0;
            FRESULT result;

            if (FR_OK == (result = f_getfree(mVolStr, &fre_clust, &pFatFs)))
            {
                /* Get total sectors and free sectors */
                unsigned int totalSectors = (pFatFs->n_fatent - 2) * pFatFs->csize;
                unsigned int freeSectors = fre_clust * pFatFs->csize;

                /* Print free space in unit of KB (assuming 512 bytes/sector) */
                *pAvailableSpaceKB  = freeSectors / 2;
                *pTotalDriveSpaceKB = totalSectors / 2;
            }

            return result;
        }

        FRESULT format() const
        {
            return f_mkfs(getDrivePath(), 0, 0);
        }

    private:
        friend class Storage;

        FileSystemObject(DriveNumberType volumeNum) :
            mVolNum(volumeNum)
        {
            mVolStr[0] = volumeNum + '0';
            mVolStr[1] = ':';
            mVolStr[2] = '\0';
        }

        FATFS mFileSystem;              
        const DriveNumberType mVolNum;  
        char mVolStr[3];                
};

#endif /* FILE_SYSTEM_OBJ_HPP__ */