generic.h File Reference

---

Detailed Description

Generic module C header file.

REVISION

• 09/26/2003 M.GAO
  Initial creation.
• 02/09/2004 M.GAO
  Added hex/ascii API function definitions.
• 03/11/2004 M.GAO
  Union IPROG code for MyFi and normal playback.
• 03/29/2004 M.GAO
  Added DJ support.

Definition in file generic.h.

#include "../feature.h"

Include dependency graph for generic.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations
enum	CODE_CONST
	Code section enumeration definitions. More...
enum	OBJ_ID
	Object ID enumerations. More...
Functions
USHORT	GEN_int2ASCII (ULONG, char *, BOOL, USHORT)
	Function converts an unsigned long integer value into ASCII character array.
void	GEN_zeroOut (UINT16 *, UINT16)
	Function zeros out specified data object.
USHORT	GEN_createTimeString (ULONG, char *)
	Function creates a time string that is ready to be displayed.
USHORT	GEN_createSizeString (ULONG, char *)
	Function creates a size string that is ready to be displayed.
void	GEN_memInit (void)
	Function initializes the SRAM memory management module.
unsigned long	GEN_malloc (unsigned short)
	Function manages the SRAM as data memory.
void	GEN_free (unsigned long)
	Function frees the allocated SRAM data buffer.
unsigned short	GEN_memsize (unsigned long)
	Function returns the allocated SRAM buffer size.
UINT	GEN_strUnpack (UINT16 *, UINT16)
	Function checks to unpack given string.
UINT	GEN_strPack (char *, const char *, UINT)
	Function packs input string and returns number of output words.
int	GEN_ascii2hex (long)
	Function turns a 32 bit ASCII number into hex format.
long	GEN_hex2ascii (int)
	Function turns a 16 bit hex number into ASCII format.
int	GEN_eepromFormat (int)
	Function checks to format the EEPROM.
int	GEN_eepromWrite (int, int, int *)
	Function reads the specified number of bytes from EEPROM.
int	GEN_eepromRead (int, int, int *)
	Function reads the specified number of bytes from EEPROM.
USHORT	GEN_checksum (USHORT *, USHORT)
	Function generates a checksum for supplied data.

---

Enumeration Type Documentation

enum CODE_CONST

Code section enumeration definitions. NOTE:This has to match definitions in GEN_load.asm. Definition at line 44 of file generic.h. Referenced by UI_SF_menu(). { SYNC_CODE, SYNC_CONST, USB_CODE, USB_CONST, DISKDB_CODE, DISKDB_CONST, MP3_CODE, MP3_CONST, PLAY_CODE, PLAY_IPROG_CODE, MYFI_IPROG_CODE, SLEEP_CODE, VOLUME_CODE, MYFICHANNEL_CODE, MSGBOX_CODE, XIM_CODE, DBMENU_CODE, SMENU_CODE, #ifdef SP_SUPPORT AUDIOMENU_CODE, #endif AUTOSCAN_CODE, DECODER_CODE, RADIO_CODE, TUNER_CODE, #ifdef WAV_SUPPORT WAV_CODE, WAV_CONST, #endif #ifdef WMA_SUPPORT WMA_CODE, WMA_CONST, #endif #ifdef OGG_SUPPORT OGG_CODE, OGG_CONST, #endif ENCODER_CODE, ENCODERINIT_CODE, RECORD_CODE, RECORDDONE_CODE, HISI_CODE, HISIDONE_CODE, MPR_CODE, MPR_CONST, WAVR_CODE, POWERUP_CODE, AUTOFF_CODE, BACKLIGHT_CODE, BKPKSWAP_CODE, CONTRAST_CODE, DATETIME_CODE, DBRECORDINFO_CODE, #ifdef DJ_SUPPORT DJMENU_CODE, #endif #ifdef M3U_SUPPORT PLAYQMENU_CODE, #endif EQMENU_CODE, HISIMENU_CODE, MAINMENU_CODE, MYFIMENU_CODE, PRESETREVIEW_CODE, PROPERTIES_CODE, RECQUALITY_CODE, REPEAT_CODE, SETTINGS_CODE, //DeepB XTRA_CODE, SHUFFLE_CODE, SYNCLOG_CODE, DIAGNOSIS_CODE, DIAG_HDD_CODE, DIAG_NAND_CODE, Invalid_Code } CODE_CONST;

enum OBJ_ID

Object ID enumerations. NOTE: THIS DEFINITION MUST MATCH THE ONE IN GEN_reinit.asm. Definition at line 130 of file generic.h. { SYNC_OBJ, USB_OBJ, DISKDB_OBJ, DB_OBJ, MP3_DECODER_OBJ, LCD_OBJ, MENU_OBJ, UI_OBJ, #ifdef WAV_SUPPORT WAV_DECODER_OBJ, #endif #ifdef WMA_SUPPORT WMA_DECODER_OBJ, #endif #ifdef OGG_SUPPORT OGG_DECODER_OBJ, #endif ENCODER_OBJ, MP3_ENCODER_OBJ, #ifdef WAV_SUPPORT WAV_ENCODER_OBJ, #endif Invalid_Object } OBJ_ID;

---

Function Documentation

int GEN_ascii2hex (  long  ascii  )

Function turns a 32 bit ASCII number into hex format. Parameters: ascii  Input ASCII number. Returns: 16 bit number in hex format. Definition at line 139 of file GEN_string.c. Referenced by SYS_serialNumber(). { int i; int ch; int hex = 0; for (i = 0; i < 4; i++) { ch = 0x0ff&(ascii>>24); if (ch >= 'A') ch -= ('A'-10); else ch -= '0'; hex <<= 4; hex |= ch; ascii <<= 8; } return hex; }

USHORT GEN_checksum (  USHORT *  pData, USHORT  len )

Function generates a checksum for supplied data. Parameters: pData  Input data len  Data length in words. Returns: 16-bit checksum. Definition at line 38 of file GEN_checksum.c. Referenced by SYS_getParams(), SYS_regist(), SYS_setParams(), UI_audioPresetUpdate(), UI_isPresetValid(), UI_presetAudio(), and UI_presetRadio(). { USHORT checkSum = *pData++; USHORT tmp; /* Following to implement an unsigned short integer rotate right. */ while(--len) { tmp = (checkSum & 0x0001)? 0x8000 : 0; checkSum >>= 1; checkSum += tmp + (*pData++); } return checkSum; }

USHORT GEN_createSizeString (  ULONG  size, char *  str )

Function creates a size string that is ready to be displayed. Function takes the following rule, if size < 100000, return xyzKB else xyzMB Parameters: size  size specified in kilo bytes. str  output string. Returns: string length in words. Definition at line 43 of file GEN_createSizeString.c. References GEN_int2ASCII(). Referenced by MENU__createDbRecordInfoMenu(), and MENU__createPropertiesMenu(). { int len = 0; int tmp; BOOL returnMB = FALSE; BOOL bLeadZero = FALSE; if( size >= 100000L ) { /* Return in MB. */ size = size/1000; returnMB = TRUE; } /* Determine if , is needed. */ if( size >= 1000 ) { tmp = size/1000; len = GEN_int2ASCII(tmp, str, FALSE, 0); str += len; *str++ = ','; len++; size %= (ULONG)1000; bLeadZero = TRUE; } tmp = GEN_int2ASCII(size, str, bLeadZero, 3); str += tmp; if(returnMB == FALSE) { *str++ = 'K'; *str++ = 'B'; } else { *str++ = 'M'; *str++ = 'B'; } *str = 0; return len + tmp + 3; }

Here is the call graph for this function:

USHORT GEN_createTimeString (  ULONG  iSecond, char *  str )

Function creates a time string that is ready to be displayed. Parameters: iSecond  Time value in seconds. str  Time string pointer. Returns: Total number of decimal bits of created time string. Definition at line 37 of file GEN_createTimeString.c. References GEN_int2ASCII(). Referenced by MENU__createDbRecordInfoMenu(), MENU__createPlayMenu(), MENU_statusBar(), and UI_PSF_recorddone(). { USHORT iSec, iHour, iMin; char * pC = str; iSec = (unsigned int)(iSecond%60); iMin = (unsigned int)((iSecond/60) % 60); iHour = (unsigned int)(iSecond/3600); /* start to create the string. */ if( iHour ) { pC += GEN_int2ASCII(iHour, pC, FALSE, 0); *pC++ = ':'; if( iMin < 10 ) *pC++ = '0'; } pC += GEN_int2ASCII(iMin, pC, FALSE, 0); *pC++ = ':'; if( iSec < 10 ) *pC++ = '0'; pC += GEN_int2ASCII(iSec, pC, FALSE, 0); /* Length does NOT include the terminated NULL. */ *pC = 0; return (pC - str); }

Here is the call graph for this function:

int GEN_eepromFormat (  int  Force  )

Function checks to format the EEPROM. Parameters: Force  If parameter is non-zero, EEPROM is formatted unconditionally. If EEPROM is not formatted (determined by looking at magic word), then it is formatted, all but the serial number. Returns: 0 if successful, otherwise -1. Definition at line 58 of file GEN_eeprom.c. References GEN_eepromRead(), and GEN_eepromWrite(). Referenced by SYS_loadParams(). { int Data; int i; unsigned long timeout = TIME_OUT; unsigned long lData; GEN_eepromRead(0, 2, &Data); if( ( Data != 0xdead ) || (Force != 0) ) { lData = (ULONG)EEPROM_WREN<<16; EEPROM__spi(EE_UNPROTECT, &lData); do { timeout--; lData = (ULONG)EEPROM_RDSR<<16; EEPROM__spi(EE_READSTATUS, &lData); while (!(lData &0x80000000L)); // wait until valid data // wait here until write enabled. // keep doing this until we time out or ready bit is set. } while ( (!(lData&0x2))&&(timeout) ); if(0 == timeout) return -1; Data = 0; for (i = EEPROM_FORMAT_BEGIN; i < EEPROM_FORMAT_END; i++) { GEN_eepromWrite(i, 1, &Data); } Data = 0xdead; GEN_eepromWrite(0, 2, &Data); } return(0); }

Here is the call graph for this function:

int GEN_eepromRead (  int  Address, int  Length, int *  ptr )

Function reads the specified number of bytes from EEPROM. bytes are big-endian aligned in a word buffer. Parameters: Address  Byte address. Length  Lenght in bytes. ptr  Byte data pointer. Returns: 0 if successfully read, otherwise -1. Definition at line 117 of file GEN_eeprom.c. Referenced by BAT_calibrate(), GEN_eepromFormat(), MENU__createPropertiesMenu(), SYS_checkRegistration(), SYS_loadParams(), SYS_regist(), and SYS_serialNumber(). { unsigned long lData; int hiByte = 0; while (Length--) { lData = ((unsigned long)EEPROM_READ<<16); lData |= (((unsigned long)Address & 0xff)<<8); lData |= (((unsigned long)Address & 0x100)<<3); EEPROM__spi(EE_READ, &lData); while(!(lData&0x80000000L)); hiByte ^= 1; if(hiByte) *ptr = (unsigned int)(lData << 8) & 0xFF00; else *ptr++ |= (unsigned int)(lData & 0x00FF); Address++; } return(0); }

int GEN_eepromWrite (  int  Address, int  Length, int *  ptr )

Function reads the specified number of bytes from EEPROM. bytes are big-endian aligned in a word buffer. Parameters: Address  Byte address. Length  Lenght in bytes. ptr  Byte data pointer. Returns: 0 if successfully written, otherwise -1. Definition at line 156 of file GEN_eeprom.c. Referenced by GEN_eepromFormat(), SYS_regist(), SYS_saveParams(), and SYS_serialNumber(). { int byte; int hiByte = 0; unsigned long lData; unsigned long timeout = TIME_OUT; // read the status register and see if it's ok to write // for reads from EEPROM, the MSBit of the word indicates valid data. // only the D0-D7 is valid, however when D15 goes high while (Length--) { lData = (ULONG)EEPROM_WREN<<16; EEPROM__spi(EE_UNPROTECT, &lData); // Wait till busy is cleared. do { timeout--; lData = (ULONG)EEPROM_RDSR<<16; EEPROM__spi(EE_READSTATUS, &lData); while (!(lData &0x80000000L)); // wait until valid data // wait here until write enabled. // keep doing this until we time out or ready bit is set. } while ( ((lData&0x01)||(!(lData&0x2)))&&(timeout) ); if(0 == timeout) return -1; timeout = TIME_OUT; hiByte ^= 1; byte = (hiByte == 1)? (*ptr) >> 8 : *ptr++ ; lData = ((unsigned long)EEPROM_WRITE<<16); lData |= ((unsigned long)Address&0xff)<<8; lData |= ((unsigned long)Address &0x100)<<3; lData |= (byte&0x0FF); EEPROM__spi(EE_WRITE, &lData); Address++; do { timeout--; lData = (ULONG)EEPROM_RDSR<<16; EEPROM__spi(EE_READSTATUS, &lData); while (!(lData &0x80000000L)); // wait until valid data // wait here until write enabled. // keep doing this until we time out or ready bit is set. //} while ( ((lData&0x01)||(!(lData&0x2)))&&(timeout) ); } while ( (lData&0x01)&&(timeout) ); if(0 == timeout) return -1; timeout = TIME_OUT; } timeout = TIME_OUT; lData = (unsigned long)EEPROM_WRDI<<16; EEPROM__spi(EE_PROTECT, &lData); do { timeout--; lData = (unsigned long)EEPROM_RDSR<<16; EEPROM__spi(EE_READSTATUS, &lData); while (!(lData &0x80000000)); // wait until valid data // keep doing this until we time out or ready bit is set. } while( ((lData&0x1) && (lData&0x2))&&(timeout) ); if(0 == timeout) return -1; return(0); }

void GEN_free (  unsigned long  dptr  )

Function frees the allocated SRAM data buffer. Parameters: dptr  SRAM data pointer. Definition at line 102 of file GEN_sramManager.c. Referenced by ENCODER_releaseObj(), MENU__restore(), MENU_action(), NAND__formatChip(), NAND_mount(), and NAND_unmount(). { unsigned long ll1, ll2; unsigned short tmp1, tmp2; if(0L == dptr) return; TSK_disable(); // Read back curren block info. GEN_rdSRAM(dptr - 1, &tmp1, 1); tmp2 = tmp1 & SRAM_SIZEMASK; ll2 = dptr - 1; // Check to merge next block. ll1 = dptr + tmp2; if( ll1 < (SRAM_MEMSTART + SRAM_MEMLENGTH) ) { GEN_rdSRAM(ll1, &tmp1, 1); if( !(tmp1 & SRAM_MEMMASK) ) { // Concatenate. tmp2 += (tmp1 + 1); } } // Check to merge previous block. ll1 = SRAM_MEMSTART; tmp1 = SRAM_MEMMASK; // Search previous block. while( ll1 != ll2 ) { GEN_rdSRAM(ll1, &tmp1, 1); ll1 += ( (tmp1 & SRAM_SIZEMASK) + 1); } if( !( tmp1 & SRAM_MEMMASK ) ) { // Concatenate. tmp2 += tmp1 + 1; ll2 -= (tmp1 + 1); } // Mark block to be free. GEN_wrSRAM(ll2, &tmp2, 1); TSK_enable(); }

long GEN_hex2ascii (  int  hex  )

Function turns a 16 bit hex number into ASCII format. Parameters: hex  Input hex number. Returns: 32 bit number in ASCII format. Definition at line 109 of file GEN_string.c. Referenced by SYS_serialNumber(). { int i; int ch; long ascii = 0; for (i = 0; i < 4; i++) { ch = 0x0f&(hex>>12); if (ch > 9) ch += ('A'-10); else ch += '0'; ascii <<= 8; ascii |= ch; hex <<= 4; } return ascii; }

USHORT GEN_int2ASCII (  ULONG  ii, char *  pC, BOOL  bZeroLead, USHORT  ASCIIbits )

Function converts an unsigned long integer value into ASCII character array. Parameters: ii  long integer that is going to be converted. pC  character array pointer. bZeroLead  determine if created array is zero leaded. If TRUE, leading zeros to fit bits specified ASCIIbits. ASCIIbits  if bZeroLead is TRUE, specifies total ouput bits, otherwise don't care. Returns: return ASCII array length in words, excluding the NULL terminator. Definition at line 45 of file GEN_int2ASCII.c. Referenced by GEN_createSizeString(), GEN_createTimeString(), MENU__createDateTimeMenu(), MENU__createPresetMenu(), MENU__createSynclogMenu(), MENU_statusBar(), UI_m3uPut(), and UI_PSF_record(). { char buf[kGenInt2AsciiBufLen]; int i; USHORT retLen; int bufLen = 0; char* pC0 = pC; // Save the original pointer. // Do-while ensures at least one iteration. If ii is zero, we want string to be '0' do{ // Isolate each digit, starting with the least significant. ULONG newii = ii / 10L; int digit = (int)(ii - (newii * 10L)); // Convert to ASCII. Digits going in backward. buf[bufLen++] = (char)(digit + '0'); ii = newii; } while (ii != 0); if (bZeroLead){ // How many leading zeros do we need to add? int nLeadingZeros = (int)ASCIIbits - bufLen; if (nLeadingZeros < 0){ return 0; // error. } for (i=0 ; i < nLeadingZeros ; i++){ *pC++ = '0'; } } for (i = bufLen-1 ; i >= 0 ; i--){ *pC++ = buf[i]; } *pC = '\0'; // Terminate the string. retLen = (USHORT)(pC - pC0); return retLen; }

unsigned long GEN_malloc (  unsigned short  size  )

Function manages the SRAM as data memory. Parameters: size  number of words to be allocated. Returns: SRAM memroy pointer. Definition at line 53 of file GEN_sramManager.c. Referenced by DB__register(), ENCODER_config(), MENU__preserve(), MENU_create(), NAND__formatChip(), and NAND_mount(). { unsigned long dptr; unsigned short tmp; unsigned short header; TSK_disable(); dptr = SRAM_MEMSTART; // Search available memory. while(dptr < (SRAM_MEMSTART + SRAM_MEMLENGTH) ) { GEN_rdSRAM(dptr, &tmp, 1); if( !(tmp & SRAM_MEMMASK) ) { // Free memory. if( tmp >= size ) { // Memory found, mark it. header = size | SRAM_MEMMASK; GEN_wrSRAM(dptr, &header, 1); // check to split memory. if( tmp > size ) { header = (tmp - size - 1); GEN_wrSRAM(dptr + size + 1, &header, 1); } TSK_enable(); return (dptr + 1); } else dptr += (tmp+1); } else dptr += ( (tmp & SRAM_SIZEMASK) + 1); } TSK_enable(); return 0L; }

unsigned short GEN_memsize (  unsigned long  dptr  )

Function returns the allocated SRAM buffer size. Parameters: dptr  SRAM data pointer. Returns: number of words in buffer. Definition at line 160 of file GEN_sramManager.c. { unsigned short size; GEN_rdSRAM(dptr - 1, &size, 1); return (size & SRAM_SIZEMASK); }

UINT GEN_strPack (  char *  out, const char *  in, UINT  len )

Function packs input string and returns number of output words. Packed string is always NULL terminated on a word boundary. Parameters: out  Output string. in  Input string. len  Input string length in words. Returns: String length in words. Definition at line 78 of file GEN_string.c. Referenced by UI_insertAudioRecord(), UI_insertHisiRecord(), and UI_m3uPut(). { unsigned int ii, jj; jj = len / 2; for( ii = 0; ii < jj; ii++) { out[ii] = (in[ii*2]<<8)|in[(ii*2) + 1]; } if(len & 0x01) { out[ii] = (in[ii*2]<<8); out[ii+1] = 0; jj++; } else out[ii] = 0; return jj + 1; }

UINT GEN_strUnpack (  UINT16 *  pData, UINT16  iDataLen )

Function checks to unpack given string. It is the caller's responsibility to make sure the buffer is big enough to hold the unpacked string. Parameters: pData  Input string. iDataLen  Packed string length. Returns: Unpacked string length. Definition at line 41 of file GEN_string.c. Referenced by MENU__create(), MENU__createListMenu(), SYS_regist(), UI_interpretAudioRecord(), UI_interpretFailedHisiRecord(), UI_interpretIdentifiedHisiRecord(), UI_interpretUnidentifiedHisiRecord(), and UI_m3uGet(). { UINT16 * pCh; UINT16 ii; if( *pData & 0xFF00 ) { ii = iDataLen; pCh = pData + ii*2 - 1; pData = pData + ii - 1; while(ii--) { *pCh-- = *pData&0x0ff; *pCh-- = (*pData--)>>8; } iDataLen *= 2; } return iDataLen; }

---