DISK_IOCTL_GETBLOCKSIZE = 4,\r
\r
/**\r
- * ioctl(..., tTplDisk_CacheRegion *Region)\r
+ * ioctl(..., tTplDisk_CacheRegion *RegionInfo)\r
* \brief Sets the cache importantce and protocol for a section of\r
* memory.\r
- * \param Region Pointer to a region information structure\r
+ * \param RegionInfo Pointer to a region information structure\r
* \return Boolean failure\r
*/\r
DISK_IOCTL_SETCACHEREGION,\r
/**\r
* ioctl(..., Uint64 *Info[2])\r
* \brief Asks the driver to precache a region of disk.\r
- * \param Info 64-bit Address and Size pair describing the area to cache\r
+ * \param Region 64-bit Address and Size pair describing the area to cache\r
* \return Number of blocks cached\r
*/\r
- DISK_IOCTL_PRECACHE\r
+ DISK_IOCTL_PRECACHE,\r
+ \r
+ /**\r
+ * ioclt(..., Uint64 *Region[2])\r
+ * \brief Asks to driver to flush the region back to disk\r
+ * \param Region 64-bit Address and Size pair describing the area to flush\r
+ * \note If Region[0] == -1 then the entire disk's cache is flushed\r
+ * \return Number of blocks flushed (or 0 for entire disk)\r
+ */\r
+ DISK_IOCTL_FLUSH\r
};\r
\r
+/**\r
+ * \brief Describes the cache parameters of a region on the disk\r
+ */\r
typedef struct sTplDisk_CacheRegion\r
{\r
Uint64 Base; //!< Base of cache region\r
*/\r
Uint8 Flags;\r
Uint8 Priority; //!< Lower is a higher proritory\r
- Uint16 CacheSize; //!< Maximum size of cache, in blocks\r
+ /**\r
+ * \brief Maximum size of cache, in blocks\r
+ * \note If CacheSize is zero, the implemenation defined limit is used\r
+ */\r
+ Uint16 CacheSize;\r
} tTplDisk_CacheRegion;\r
\r
/**\r
enum eTplDisk_CacheProtocols\r
{\r
/**\r
- * \brief Region is not cached\r
+ * \brief Don't cache the region\r
*/\r
+ \r
DISK_CACHEPROTO_DONTCACHE,\r
/**\r
* \brief Most recently used blocks cached\r
/**\r
* \brief Cache only on demand\r
* \r
- * Only cache when the ::DISK_IOCTL_PRECACHE ioctl is used\r
+ * Only cache when the ::DISK_IOCTL_PRECACHE IOCtl is used\r
*/\r
DISK_CACHEPROTO_EXPLICIT\r
};\r
+\r
+/**\r
+ * \brief Flags for the cache\r
+ */\r
enum eTplDisk_CacheFlags\r
{\r
- DISK_CACHEFLAG_WRITETHROUGH\r
+ /**\r
+ * \brief Write all changes to the region straight back to media\r
+ */\r
+ DISK_CACHEFLAG_WRITETHROUGH = 0x10\r
};\r
\r
/**\r
* \brief IOCtl name strings\r
*/\r
-#define DRV_DISK_IOCTLNAMES "get_block_size", "set_cache_region"\r
+#define DRV_DISK_IOCTLNAMES "get_block_size","set_cache_region","set_precache"\r
\r
/**\r
- * \section Disk Driver Utilities\r
+ * \name Disk Driver Utilities\r
+ * \{\r
*/\r
\r
/**\r
tDrvUtil_Callback ReadBlocks, tDrvUtil_Callback WriteBlocks,\r
Uint64 BlockSize, Uint Argument);\r
\r
+/**\r
+ * \}\r
+ */\r
+\r
#endif\r