Initializes ports appropriately for communication with CF card.

None.

Nothing.

External dependencies of the library from the top of the page must be defined before using this function.

// set compact flash pinout 
char Cf_Data_Port at PORTF;

sbit CF_RDY at RD7_bit;
sbit CF_WE  at RD6_bit;
sbit CF_OE  at RD5_bit;
sbit CF_CD1 at RD4_bit;
sbit CF_CE1 at RD3_bit;
sbit CF_A2  at RD2_bit;
sbit CF_A1  at RD1_bit;
sbit CF_A0  at RD0_bit;

sbit CF_RDY_direction at TRISD7_bit;
sbit CF_WE_direction  at TRISD6_bit;
sbit CF_OE_direction  at TRISD5_bit;
sbit CF_CD1_direction at TRISD4_bit;
sbit CF_CE1_direction at TRISD3_bit;
sbit CF_A2_direction  at TRISD2_bit;
sbit CF_A1_direction  at TRISD1_bit;
sbit CF_A0_direction  at TRISD0_bit;
// end of compact flash pinout
...
Cf_Init();      // initialize CF 

None.

Checks for presence of CF card by reading the chip detect pin.

None.

• 1 - if CF card was detected
• 0 - otherwise

The corresponding MCU ports must be appropriately initialized for CF card. See Cf_Init.

// Wait until CF card is inserted:
do
  asm nop;
while (!Cf_Detect());

dsPIC30 family MCU and CF card voltage levels are different. The user must ensure that MCU's pin connected to CD line can read CF card Logical One correctly.

Enables the device. Routine needs to be called only if you have disabled the device by means of the Cf_Disable routine. These two routines in conjunction allow you to free/occupy data line when working with multiple devices.

None.

Nothing.

The corresponding MCU ports must be appropriately initialized for CF card. See Cf_Init.

// enable compact flash
Cf_Enable();

None.

Routine disables the device and frees the data lines for other devices. To enable the device again, call Cf_Enable. These two routines in conjunction allow you to free/occupy data line when working with multiple devices.

None.

Nothing.

The corresponding MCU ports must be appropriately initialized for CF card. See Cf_Init.

// disable compact flash
Cf_Disable();

None.

Initializes CF card for reading.

• address: the first sector to be prepared for reading operation.
• sector_count: number of sectors to be prepared for reading operation.

Nothing.

The corresponding MCU ports must be appropriately initialized for CF card. See Cf_Init.

// initialize compact flash for reading from sector 590
Cf_Read_Init(590, 1);

None.

Reads one byte from Compact Flash sector buffer location currently pointed to by internal read pointers. These pointers will be autoicremented upon reading.

None.

Returns a byte read from Compact Flash sector buffer.

The corresponding MCU ports must be appropriately initialized for CF card. See Cf_Init.

CF card must be initialized for reading operation. See Cf_Read_Init.

// Read a byte from compact flash:
unsigned char data_;
...
data_ = Cf_Read_Byte();

Initializes CF card for writing.

• address: the first sector to be prepared for writing operation.
• sectcnt: number of sectors to be prepared for writing operation.

Nothing.

The corresponding MCU ports must be appropriately initialized for CF card. See Cf_Init.

// initialize compact flash for writing to sector 590
Cf_Write_Init(590, 1);

None.

Writes a byte to Compact Flash sector buffer location currently pointed to by writing pointers. These pointers will be autoicremented upon reading. When sector buffer is full, its contents will be transfered to appropriate flash memory sector.

• data_: byte to be written.

Nothing.

The corresponding MCU ports must be appropriately initialized for CF card. See Cf_Init.

CF card must be initialized for writing operation. See Cf_Write_Init.

char data_ = 0xAA;
...
Cf_Write_Byte(data_);

None.

Reads one sector (512 bytes). Read data is stored into buffer provided by the buffer parameter.

• sector_number: sector to be read.
• buffer: data buffer of at least 512 bytes in length.

Nothing.

The corresponding MCU ports must be appropriately initialized for CF card. See Cf_Init.

// read sector 22
unsigned short data[512];
...
Cf_Read_Sector(22, data);

None.

Writes 512 bytes of data provided by the buffer parameter to one CF sector.

• sector_number: sector to be written to.
• buffer: data buffer of 512 bytes in length.

Nothing.

The corresponding MCU ports must be appropriately initialized for CF card. See Cf_Init.

// write to sector 22
unsigned short data[512];
...
Cf_Write_Sector(22, data);

None.

Initializes CF card, reads CF FAT16 boot sector and extracts necessary data needed by the library.

None.

• 0 - if CF card was detected and successfully initialized
• 1 - if FAT16 boot sector was not found
• 255 - if card was not detected

Nothing.

// Init the FAT library
if (!Cf_Fat_Init()) {    // Init the FAT library
...
}

None.

Formats to FAT16 and initializes CF card.

• cf_fat_label: volume label (11 characters in length). If less than 11 characters are provided, the label will be padded with spaces. If null string is passed, the volume will not be labeled.

• 0 - if CF card was detected, successfully formated and initialized
• 1 - if FAT16 format was unsuccessful
• 255 - if card was not detected

Nothing.

//  format and initialize the FAT library - 
if (!Cf_Fat_QuickFormat(&cf_fat_label)) {
...
}

• This routine can be used instead or in conjunction with Cf_Fat_Init routine.
• If CF card already contains a valid boot sector, it will remain unchanged (except volume label field) and only FAT and ROOT tables will be erased. Also, the new volume label will be set.

Assigns file for file operations (read, write, delete...). All subsequent file operations will be applied over the assigned file.

• filename: name of the file that should be assigned for file operations. The file name should be in DOS 8.3 (file_name.extension) format. The file name and extension will be automatically padded with spaces by the library if they have less than length required (i.e. "mikro.tx" -> "mikro .tx "), so the user does not have to take care of that. The file name and extension are case insensitive. The library will convert them to proper case automatically, so the user does not have to take care of that.

  Also, in order to keep backward compatibility with the first version of this library, file names can be entered as UPPERCASE string of 11 bytes in length with no dot character between the file name and extension (i.e. "MIKROELETXT" -> MIKROELE.TXT). In this case the last 3 characters of the string are considered to be file extension.

• file_cre_attr: file creation and attributes flags. Each bit corresponds to the appropriate file attribute:

Bit	Mask	Description
0	0x01	Read Only
1	0x02	Hidden
2	0x04	System
3	0x08	Volume Label
4	0x10	Subdirectory
5	0x20	Archive
6	0x40	Device (internal use only, never found on disk)
7	0x80	File creation flag. If the file does not exist and this flag is set, a new file with specified name will be created.

• 0 if file does not exist and no new file is created.
• 1 if file already exists or file does not exist but a new file is created.

CF card and CF library must be initialized for file operations. See Cf_Fat_Init.

// create file with archive attributes if it does not already exist
Cf_Fat_Assign("MIKRO007.TXT",0xA0);

Opens currently assigned file for reading.

• size: buffer to store file size to. After file has been open for reading its size is returned through this parameter.

Nothing.

CF card and CF library must be initialized for file operations. See Cf_Fat_Init.

File must be previously assigned. See Cf_Fat_Assign.

unsigned long size;
...
Cf_Fat_Reset(size);

None.

Reads a byte from currently assigned file opened for reading. Upon function execution file pointers will be set to the next character in the file.

• bdata: buffer to store read byte to. Upon this function execution read byte is returned through this parameter.

Nothing.

CF card and CF library must be initialized for file operations. See Cf_Fat_Init.

File must be previously assigned. See Cf_Fat_Assign.

File must be open for reading. See Cf_Fat_Reset.

char character;
...
Cf_Fat_Read(&character);

None.

Opens currently assigned file for writing. If the file is not empty its content will be erased.

None.

Nothing.

CF card and CF library must be initialized for file operations. See Cf_Fat_Init.

The file must be previously assigned. See Cf_Fat_Assign.

// open file for writing
Cf_Fat_Rewrite();

None.

Opens currently assigned file for appending. Upon this function execution file pointers will be positioned after the last byte in the file, so any subsequent file writing operation will start from there.

None.

Nothing.

CF card and CF library must be initialized for file operations. See Cf_Fat_Init.

File must be previously assigned. See Cf_Fat_Assign.

// open file for appending
Cf_Fat_Append();

None.

Deletes currently assigned file from CF card.

None.

Nothing.

CF card and CF library must be initialized for file operations. See Cf_Fat_Init.

File must be previously assigned. See Cf_Fat_Assign.

// delete current file
Cf_Fat_Delete();

None.

Writes requested number of bytes to currently assigned file opened for writing.

• fdata: data to be written.
• data_len: number of bytes to be written.

Nothing.

CF card and CF library must be initialized for file operations. See Cf_Fat_Init.

File must be previously assigned. See Cf_Fat_Assign.

File must be open for writing. See Cf_Fat_Rewrite or Cf_Fat_Append.

char file_contents[42];
...
Cf_Fat_Write(file_contents, 42); // write data to the assigned file

None.

Sets the date/time stamp. Any subsequent file writing operation will write this stamp to currently assigned file's time/date attributes.

• year: year attribute. Valid values: 1980-2107
• month: month attribute. Valid values: 1-12
• day: day attribute. Valid values: 1-31
• hours: hours attribute. Valid values: 0-23
• mins: minutes attribute. Valid values: 0-59
• seconds: seconds attribute. Valid values: 0-59

Nothing.

CF card and CF library must be initialized for file operations. See Cf_Fat_Init.

File must be previously assigned. See Cf_Fat_Assign.

File must be open for writing. See Cf_Fat_Rewrite or Cf_Fat_Append.

Cf_Fat_Set_File_Date(2005,9,30,17,41,0);

None.

Reads time/date attributes of currently assigned file.

• year: buffer to store year attribute to. Upon function execution year attribute is returned through this parameter.
• month: buffer to store month attribute to. Upon function execution month attribute is returned through this parameter.
• day: buffer to store day attribute to. Upon function execution day attribute is returned through this parameter.
• hours: buffer to store hours attribute to. Upon function execution hours attribute is returned through this parameter.
• mins: buffer to store minutes attribute to. Upon function execution minutes attribute is returned through this parameter.

Nothing.

CF card and CF library must be initialized for file operations. See Cf_Fat_Init.

File must be previously assigned. See Cf_Fat_Assign.

unsigned year;
char month, day, hours, mins;
...
Cf_Fat_Get_File_Date(&year, &month, &day, &hours, &mins);

None.

Retrieves the last modification date/time of the currently assigned file.

• year: buffer to store year of modification attribute to. Upon function execution year of modification attribute is returned through this parameter.
• month: buffer to store month of modification attribute to. Upon function execution month of modification attribute is returned through this parameter.
• day: buffer to store day of modification attribute to. Upon function execution day of modification attribute is returned through this parameter.
• hours: buffer to store hours of modification attribute to. Upon function execution hours of modification attribute is returned through this parameter.
• mins: buffer to store minutes of modification attribute to. Upon function execution minutes of modification attribute is returned through this parameter.

Nothing.

CF card and CF library must be initialized for file operations. See Cf_Fat_Init.

File must be previously assigned. See Cf_Fat_Assign.

unsigned year;
char month, day, hours, mins;
...
Cf_Fat_Get_File_Date_Modified(&year, &month, &day, &hours, &mins);

None.

This function reads size of currently assigned file in bytes.

None.

Size of the currently assigned file in bytes.

CF card and CF library must be initialized for file operations. See Cf_Fat_Init.

File must be previously assigned. See Cf_Fat_Assign.

unsigned long my_file_size;
...
my_file_size = Cf_Fat_Get_File_Size();

None.

This function is used to create a swap file of predefined name and size on the CF media. If a file with specified name already exists on the media, search for consecutive sectors will ignore sectors occupied by this file. Therefore, it is recommended to erase such file if it exists before calling this function. If it is not erased and there is still enough space for a new swap file, this function will delete it after allocating new memory space for a new swap file.

The purpose of the swap file is to make reading and writing to CF media as fast as possible, by using the Cf_Read_Sector() and Cf_Write_Sector() functions directly, without potentially damaging the FAT system. Swap file can be considered as a "window" on the media where the user can freely write/read data. It's main purpose in the this library is to be used for fast data acquisition; when the time-critical acquisition has finished, the data can be re-written into a "normal" file, and formatted in the most suitable way.

• sectors_cnt: number of consecutive sectors that user wants the swap file to have.
• filename: name of the file that should be assigned for file operations. The file name should be in DOS 8.3 (file_name.extension) format. The file name and extension will be automatically padded with spaces by the library if they have less than length required (i.e. "mikro.tx" -> "mikro .tx "), so the user does not have to take care of that. The file name and extension are case insensitive. The library will convert them to proper case automatically, so the user does not have to take care of that.

  Also, in order to keep backward compatibility with the first version of this library, file names can be entered as UPPERCASE string of 11 bytes in length with no dot character between the file name and extension (i.e. "MIKROELETXT" -> MIKROELE.TXT). In this case the last 3 characters of the string are considered to be file extension.

• file_attr: file creation and attributes flags. Each bit corresponds to the appropriate file attribute:

Bit	Mask	Description
0	0x01	Read Only
1	0x02	Hidden
2	0x04	System
3	0x08	Volume Label
4	0x10	Subdirectory
5	0x20	Archive
6	0x40	Device (internal use only, never found on disk)
7	0x80	Not used

• Number of the start sector for the newly created swap file, if there was enough free space on CF card to create file of required size.
• 0 - otherwise.

CF card and CF library must be initialized for file operations. See Cf_Fat_Init.

//-------------- Try to create a swap file with archive atribute, whose size will be at least 1000 sectors.
//               If it succeeds, it sends the No. of start sector over UART
unsigned long size;
...
size = Cf_Fat_Get_Swap_File(1000, "mikroE.txt", 0x20);
if (size) {
  UART1_Write(0xAA);
  UART1_Write(Lo(size));
  UART1_Write(Hi(size));
  UART1_Write(Higher(size));
  UART1_Write(Highest(size));
  UART1_Write(0xAA);
}