Files
itgmania212121/stepmania/src/arch/MemoryCard/MemoryCardDriver.h
T
2005-12-10 02:21:11 +00:00

130 lines
4.2 KiB
C++

#ifndef MEMORY_CARD_DRIVER_H
#define MEMORY_CARD_DRIVER_H
struct UsbStorageDevice
{
UsbStorageDevice() { MakeBlank(); }
void MakeBlank()
{
// -1 means "don't know"
iBus = -1;
iPort = -1;
iLevel = -1;
sDevice = "";
sSerial = "<none>"; // be different than a card with no serial
sOsMountDir = "";
m_State = STATE_NONE;
bIsNameAvailable = false;
sName = "";
idVendor = 0;
idProduct = 0;
sVendor = "";
sProduct = "";
sVolumeLabel = "";
iVolumeSizeMB = 0;
};
int iBus;
int iPort;
int iLevel;
CString sSerial;
CString sDevice;
CString sOsMountDir; // WITHOUT trailing slash
CString sSysPath; // Linux: /sys/block name
enum State
{
/* Empty device. This is used only by MemoryCardManager. */
STATE_NONE,
/* The card has been detected, but we havn't finished write tests, loading
* the quick profile information, etc. yet. We can display something on
* screen, in order to appear responsive, show that something's happening and
* aid diagnostics, though. */
STATE_CHECKING,
/* We can't write to the device; it may be write-protected, use a filesystem
* that we don't understand, unformatted, etc. */
STATE_ERROR,
/* The device is ready and usable. sName is filled in, if available. */
STATE_READY,
};
State m_State;
CString m_sError;
void SetError( const CString &sError ) { m_State = STATE_ERROR; m_sError = sError; }
bool bIsNameAvailable; // Name in the profile on the memory card.
CString sName; // Name in the profile on the memory card.
int idVendor;
int idProduct;
CString sVendor;
CString sProduct;
CString sVolumeLabel;
int iVolumeSizeMB;
bool IsBlank() const { return m_State == STATE_NONE; }
void SetOsMountDir( const CString &s );
bool operator==(const UsbStorageDevice& other) const;
};
class MemoryCardDriver
{
public:
MemoryCardDriver() {};
virtual ~MemoryCardDriver() {};
/* Make a device accessible via its pDevice->sOsMountDir. This will be called
* before any access to the device, and before TestWrite. */
virtual bool Mount( UsbStorageDevice* pDevice ) = 0;
virtual void Unmount( UsbStorageDevice* pDevice ) = 0;
virtual void Flush( UsbStorageDevice* pDevice ) = 0;
virtual void Reset() { }
/* Poll for memory card changes. If anything has changed, fill in vStorageDevicesOut
* and return true. */
virtual bool DoOneUpdate( bool bMount, vector<UsbStorageDevice>& vStorageDevicesOut );
protected:
/* This may be called before GetUSBStorageDevices; return false if the results of
* GetUSBStorageDevices have not changed. (This is an optimization.) */
virtual bool USBStorageDevicesChanged() { return true; }
virtual void GetUSBStorageDevices( vector<UsbStorageDevice>& vDevicesOut ) { }
/* Test the device. On failure, call pDevice->SetError() appropriately, and return false. */
virtual bool TestWrite( UsbStorageDevice* pDevice ) { return true; }
private:
vector<UsbStorageDevice> m_vDevicesLastSeen;
bool NeedUpdate( bool bMount );
};
#endif
/*
* (c) 2003-2004 Chris Danford
* All rights reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, and/or sell copies of the Software, and to permit persons to
* whom the Software is furnished to do so, provided that the above
* copyright notice(s) and this permission notice appear in all copies of
* the Software and that both the above copyright notice(s) and this
* permission notice appear in supporting documentation.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF
* THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS
* INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT
* OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
* OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
* OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
* PERFORMANCE OF THIS SOFTWARE.
*/