Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
en:software:homelab:library:module:sdcard [2012/05/16 12:50] – created raivo.sellen:software:homelab:library:module:sdcard [2020/07/20 12:00] (current) – external edit 127.0.0.1
Line 1: Line 1:
-====== SD kaart ====== +====== SD-card ======
-<note important>Translation needed</note> +
-//Seotud mooduliga: [HW] [[et:hardware:homelab:controller]]//+
  
-See teegi osa sisaldab Kodulabori SD kaardi kasutamise funktsioone.+//Necessary knowledge: [HW] [[en:hardware:homelab:controller]]//
  
-===== Andmetüübid =====+This section of library contains functions for using HomeLab SD-card.
  
-  * **//static FATFS FATFS_Obj//** -  FATFS_Obj on FATFS andmestruktuuri instants.  Sisaldab ketaste identifikaatoreid.+===== Data types =====
  
-  * **//FIL fil_obj//** - Failisüsteemi andmestruktuur, kuhu salvestatakse failide identifikaatorid.+  * **//static FATFS FATFS_Obj//** -  FATFS_Obj is FATFS data structure instance. Consists of drive identificators.
  
-  * **//DSTATUS//** - Koodid, mida kettaga seotud funktsioonid tagastavad. +  * **//FIL fil_obj//** - File system data structure where to store file identificators.
-    * //RES_OK// - (0) Toiming õnnestus. +
-    * //RES_ERROR// - (1) R/W viga. +
-    * //RES_WRPRT// - (2) Kirjutuskaitstud. +
-    * //RES_NOTRDY// - (3) Ketas ei ole valmis. +
-    * //RES_PARERR// - (4) Mõni parameetritest on vale.+
  
-  * **//FRESULT//** - Tähtsamad koodid, mida failidega seotud funktsioonid tagastavad+  * **//DSTATUS//** - Return codes for drive related functions
-    * //FR_OK// - (0) Toiming õnnestus+    * //RES_OK// - (0) Procedure successful
-    * //FR_DISK_ERR// - (1) Ketta I/O kihi viga+    * //RES_ERROR// - (1) R/W error
-    * //FR_INT_ERR// - (2) Üldine ketta viga+    * //RES_WRPRT// - (2) Write protected
-    * //FR_NOT_READY// - (3) Ketas ei ole toiminguks valmis+    * //RES_NOTRDY// - (3) Drive not ready
-    * //FR_NO_FILE// - (4) Faili ei leitud. +    * //RES_PARERR// - (4) Some parameters are false.
-    * //FR_NO_PATH// - (5) Aadressi ei leitud. +
-    * //FR_INVALID_NAME// - (6) Vale faili nimeformaat. +
-    * //FR_DENIED// - (7) Ketas on täis. +
-    * //FR_EXIST// - (8) Juurdepääs on keelatud. +
-    * //FR_INVALID_OBJECT// - (9) Faili / kausta objekt on vigane. +
-    * //FR_WRITE_PROTECTED// - (10) Ketas on kirjutuskaitstud. +
-    * //FR_INVALID_DRIVE// - (11) Ketta number on vale. +
-    * //FR_NO_FILESYSTEM// - (13) Toetatud FAT failisüsteemi ei leitud. +
-    * //FR_TIMEOUT// - (15) Kettaga ei saadud ühendust. +
-    * //FR_INVALID_PARAMETER// - (19) Mõni parameeter on vale.+
  
-  * **//ModeFlags//** - Faili võimalikud avamisrežiimid+  * **//FRESULT//** - Most important codes that are returned from file related functions
-    * //FA_READ// - Fail avatakse lugemisrežiimis+    * //FR_OK// - (0) Procedure successful
-    * //FA_WRITE// - Fail avatakse kirjutusrežiimis+    * //FR_DISK_ERR// - (1) Drive I/O layer error 
-    * //FA_OPEN_EXISTING// - Avab failiKui faili ei ole, siis tagastatakse veakood+    * //FR_INT_ERR// - (2) General drive error 
-    * //FA_OPEN_ALWAYS// - Avab failiKui faili ei ole, siis loob selle+    * //FR_NOT_READY// - (3) Drive not ready for procedure
-    * //FA_CREATE_NEW// - Loob uue failiKui fail on juba olemas, siis tagastatakse veakood+    * //FR_NO_FILE// - (4) File not found. 
-    * //FA_CREATE_ALWAYS// - Loob uue failiKui fail on juba olemas, siis kirjutatakse see üle.+    * //FR_NO_PATH// - (5) Address not found
 +    * //FR_INVALID_NAME// - (6) Wrong file name format. 
 +    * //FR_DENIED// - (7) Drive is full
 +    * //FR_EXIST// - (8) Access is denied. 
 +    * //FR_INVALID_OBJECT// - (9) File or folder object error
 +    * //FR_WRITE_PROTECTED// - (10) Drive is write protected. 
 +    * //FR_INVALID_DRIVE// - (11) Drive number is false. 
 +    * //FR_NO_FILESYSTEM// - (13) Supported FAT file system not found. 
 +    * //FR_TIMEOUT// - (15) Connection with drive failed. 
 +    * //FR_INVALID_PARAMETER// - (19) Some parameters are false.
  
 +  * **//ModeFlags//** - Possible modes to open files.
 +    * //FA_READ// - File open in read mode.
 +    * //FA_WRITE// - File open in write mode.
 +    * //FA_OPEN_EXISTING// - Opens file. If it does not exists then returns error code.
 +    * //FA_OPEN_ALWAYS// - Opens file. If it does not exists then creates it.
 +    * //FA_CREATE_NEW// - Creates new file. If files is already present, error code will be returned.
 +    * //FA_CREATE_ALWAYS// - Creates new file. If files is already present then overwrites it.
  
  
-===== Funktsioonid =====+===== Functions =====
  
   * **//DSTATUS disk_initialize (BYTE drv)//** \\   * **//DSTATUS disk_initialize (BYTE drv)//** \\
-   Seadistab kettaParameetrid+   Initializes driveParameters
-    * //drv// - Ketta number. Enamus juhtudel 0. +    * //drv// - Drive number. In most cases 0. 
-    * Tagastab DSTATUS koodi.+    * Returns DSTATUS code.
  
   * **//DSTATUS disk_status (BYTE drv)//** \\   * **//DSTATUS disk_status (BYTE drv)//** \\
-   Näitab ketta olekutParameetrid+   Displays drive statusParameters
-    * //drv// - Ketta number. Enamus juhtudel 0. +    * //drv// - Drive number. In most cases 0. 
-    * Tagastab DSTATUS koodi.+    * Returns DSTATUS code.
  
   * **//FRESULT f_mount (BYTE Drive, FATFS* FileSystemObject)//** \\   * **//FRESULT f_mount (BYTE Drive, FATFS* FileSystemObject)//** \\
-   Seadistab failisüsteemiParameetrid+   Initializes file systemParameters
-    * //Drive// - Ketta number. Enamus juhtudel 0. +    * //Drive// - Drive number. In most cases 0. 
-    * //FileSystemObject//Viit failisüsteemi objektile+    * //FileSystemObject//File system object pointer
-    * Tagastab FRESULT koodi.+    * Returns FRESULT code.
  
   * **//FRESULT f_open (FIL* FileObject, const TCHAR* FileName, BYTE ModeFlags)//** \\   * **//FRESULT f_open (FIL* FileObject, const TCHAR* FileName, BYTE ModeFlags)//** \\
-   Avab või loob failiParameetrid+   Opens or creates fileParameters
-    * //FileObject//Viit failisüsteemi objektile+    * //FileObject//File system object pointer
-    * //FileName//Faili nimi+    * //FileName//File name
-    * //ModeFlags//Avamisrežiimi lipp+    * //ModeFlags//Open mode flag
-    * Tagastab FRESULT koodi.+    * Returns FRESULT code.
  
   * **//FRESULT f_close (FIL* FileObject)//** \\   * **//FRESULT f_close (FIL* FileObject)//** \\
-   Suleb failiParameetrid+   Closes fileParameters
-    * //FileObject//Viit failisüsteemi objektile+    * //FileObject//File system object pointer
-    * Tagastab FRESULT koodi.+    * Returns FRESULT code.
  
   * **//FRESULT f_read (FIL* FileObject, void* Buffer, UINT ByteToRead, UINT* ByteRead)//** \\   * **//FRESULT f_read (FIL* FileObject, void* Buffer, UINT ByteToRead, UINT* ByteRead)//** \\
-   Loeb failist etteantud arv baite andmeidParameetrid+   Reads required amount of bytes from fileParameters
-    * //FileObject//Viit failiobjektile+    * //FileObject//File object pointer
-    * //Buffer// - Viit puhvrile, kuhu kirjutatakse loetud andmed+    * //Buffer// - Buffer pointer where to store data
-    * //ByteToRead//Loetavate baitide arv+    * //ByteToRead//Number of files to be read
-    * //ByteRead//Viit muutujale, kuhu tagastatakse loetud baidid+    * //ByteRead//Variable pointer where read bytes are returned
-    * Tagastab FRESULT koodi.+    * Returns FRESULT code.
  
   * **//FRESULT f_write (FIL* FileObject, const void* Buffer, UINT ByteToWrite, UINT* ByteWritten)//** \\   * **//FRESULT f_write (FIL* FileObject, const void* Buffer, UINT ByteToWrite, UINT* ByteWritten)//** \\
-   Kirjutab faili etteantud arv baite andmeidParameetrid+   Writes required amount of bytes to fileParameters
-    * //FileObject//Viit failiobjektile+    * //FileObject//Point to file object
-    * //Buffer// - Viit andmetele, mis kirjutatakse faili+    * //Buffer// - Point to data being written into file
-    * //ByteToWrite//Kirjutatavate baitide arv+    * //ByteToWrite//Number of bytes to be written
-    * //ByteWritten//Viit muutujale, kuhu tagastatakse kirjutatud baidid+    * //ByteWritten//Point to variable where written bytes are returned
-    * Tagastab FRESULT koodi.+    * Returns FRESULT code.
  
   * **//FRESULT f_sync (FIL* FileObject)//** \\   * **//FRESULT f_sync (FIL* FileObject)//** \\
-   Kirjutab puhvrites olevad andmed fail, et vähendada andmekadu voolukatkestuse korralKasutatakse rakendustes, kus fail on väga pikka aega avatudParameetrid+   Writes data from buffers to a file to save them from power lossUsed in applications where a file is open for a long timeParameters
-    * //FileObject//Viit failiobjektile.    +    * //FileObject//Point to file object.    
-    * Tagastab FRESULT koodi.+    * Returns FRESULT code.
  
   * **//FRESULT f_mkdir (const TCHAR* DirName)//** \\   * **//FRESULT f_mkdir (const TCHAR* DirName)//** \\
-   Loob kaustaParameetrid+   Creates folderParameters
-    * //DirName// - Kausta nimi.    +    * //DirName// - Folder name.    
-    * Tagastab FRESULT koodi.+    * Returns FRESULT code.
  
   * **//FRESULT f_unlink (const TCHAR* FileName)//** \\   * **//FRESULT f_unlink (const TCHAR* FileName)//** \\
-   Kustutab faili või kaustaParameetrid+   Deletes file or folderParameters
-    * //FileName//Objekti nimi.    +    * //FileName//Object name.    
-    * Tagastab FRESULT koodi.+    * Returns FRESULT code.
  
   * **//FRESULT f_rename (const TCHAR* OldName, const TCHAR* NewName)//** \\   * **//FRESULT f_rename (const TCHAR* OldName, const TCHAR* NewName)//** \\
-   Nimetab faili või kausta ümberParameetrid+   Rename file or folderParameters
-    * //OldName// - Objekti vana nimi.  +    * //OldName// - Object old name.  
-    * //NewName// - Objekti uus nimi.    +    * //NewName// - Object new name.    
-    * Tagastab FRESULT koodi.+    * Returns FRESULT code.
  
   * **//TCHAR* f_gets (TCHAR* Str, int Size, FIL* FileObject)//** \\   * **//TCHAR* f_gets (TCHAR* Str, int Size, FIL* FileObject)//** \\
-   Loeb failist etteantud pikkusega stringiParameetrid+   Reads string with given length from fileParameters
-    * //Str// - Puhver, kuhu loetud andmed salvestatakse.  +    * //Str// - Buffer where to save read data.  
-    * //Size// - Stringi pikkus  +    * //Size// - Length of string
-    * //FileObject//Viit failiobjektile.  +    * //FileObject//Point to file object.  
-    * Tagastab Str puhvri, kui oli edukas.+    * Returns Str buffer if successful.
  
   * **//int f_putc (TCHAR Chr, FIL* FileObject)//** \\   * **//int f_putc (TCHAR Chr, FIL* FileObject)//** \\
-   Lisab faili tähemärgiParameetrid+   Adds a char to fileParameters
-    * //Chr// - Tähemärk, mis lisatakse faili.  +    * //Chr// - Char to be added into file.  
-    * //FileObject//Viit failiobjektile.  +    * //FileObject//File object pointer .  
-    * Tagastab 1, kui oli edukas.+    * Returns if successful.
  
   * **//int f_printf (FIL* FileObject, const TCHAR* Foramt, ...)//** \\   * **//int f_printf (FIL* FileObject, const TCHAR* Foramt, ...)//** \\
-   Lisab faili vormindatud stringiParameetrid:     +   Adds a formated string to fileParameters:     
-    * //FileObject//Viit failiobjektile+    * //FileObject//File object pointer
-    * //Foramt// - Stringi formaat+    * //Foramt// - String format
     * ...      * ... 
-    * Tagastab kirjutatud märkide arvu, kui oli edukas.+    * Returns the number of written chars if successful.
            
   * **//DWORD f_tell (FIL* FileObject)//** \\   * **//DWORD f_tell (FIL* FileObject)//** \\
-   Kursori asukoht failisParameetrid:     +   Cursor position in fileParameters:     
-    * //FileObject//Viit failiobjektile.     +    * //FileObject//File object pointer.     
-    * Tagastab viitena lugemis/kirjutamiskursori asukoha failis.+    * Returns read/write cursor position in file as a pointer.
  
   * **//FRESULT f_lseek (FIL* FileObject,DWORD Offset)//** \\   * **//FRESULT f_lseek (FIL* FileObject,DWORD Offset)//** \\
-   Viib kursori sooovitud asukohta failisParameetrid:     +   Move cursor to desired position in fileParameters:     
-    * //FileObject//Viit failiobjektile.  +    * //FileObject//File object pointer.  
-    * //Offset// - Soovitud asukoht baitides faili algusest.    +    * //Offset// - Desired position in bytes from the beginning of the file.    
-    * Tagastab FRESULT koodi.+    * Returns FRESULT code.
      
  
  
-~~PB~~+<pagebreak>
  
-===== Näide =====+===== Example =====
  
 <code c> <code c>
Line 159: Line 158:
     FIL fil_obj;     FIL fil_obj;
  
- // SD kaardi initsialiseerimine+ // SD card initialization
  disk_initialize(0);  disk_initialize(0);
  
- // Failisüsteemi initsialiseerimine+ // File system initialization
  f_mount(0, &FATFS_Obj);  f_mount(0, &FATFS_Obj);
  
- // Tekitatakse tekstifail "fail.txt"+ // Create text file "file.txt"
- f_open(&fil_obj, "/fail.txt", FA_CREATE_NEW);+ f_open(&fil_obj, "/file.txt", FA_CREATE_NEW);
  
- // Fail avatakse kirjutusreziimis+ // File to be open for writing
- f_open(&fil_obj, "/fail.txt", FA_WRITE);+ f_open(&fil_obj, "/file.txt", FA_WRITE);
  
- // Faili kirjutamine.+ // Writing into file.
  f_printf(&fil_obj, "SD Card test");  f_printf(&fil_obj, "SD Card test");
    
-  // Faili sulgemine+  // Close file.
  f_close(&fil_obj);   f_close(&fil_obj);
 } }
en/software/homelab/library/module/sdcard.1337161835.txt.gz · Last modified: (external edit)
CC Attribution-Share Alike 4.0 International
www.chimeric.de Valid CSS Driven by DokuWiki do yourself a favour and use a real browser - get firefox!! Recent changes RSS feed Valid XHTML 1.0