IPC@CHIP® RTOS-PPC – API Documentation

Header image

Main page


BIOS API types and data structures


Detailed Description

The BIOS API defines the following types:

Data Structures

struct  BiosRegBufS
 Fixed point register dump from exception. More...
struct  BiosFregBufS
 Floating-point register dump from exception. More...
struct  BiosFaultRecS
 Exception fault report for BIOS_Set_Error_Handler() callback. More...
struct  CmdFeedbackS
 Used by BIOS_ExecuteExt() API for FORMAT and COPY commands. More...
struct  DiskStatS
 Used by BIOS_ExecuteExt() API for CHKDSK command. More...
struct  PfiStatS
 Used by BIOS_ExecuteExt() API for PFI command. More...
struct  ProgFeedbackS
 Used by BIOS_ExecuteExt() API for invoking another program with feedback. More...
struct  BiosDiskInfo
 Disk size information. More...
struct  FS_FILETIME
 File time. More...
struct  FILE_FIND
 Findfirst/Findnext data structure (short file names). More...
struct  LFN_FILE_FIND
 Findfirst/Findnext data structure (long file names). More...
struct  USER_STDIO_FUNCS
 User specific stdio functions. More...
struct  ServerCredentials
 For modifying FTP, Telnet or SSH user/pw settings. More...

Defines

#define BDC_SAVE_1_FAT   0x1
 BIOS_Disk_Close() saves only one copy of FAT.
#define BDC_ABORT_READ_WRITE   0x2
 BIOS_Disk_Close() signals sector read/write in progress to abort.
#define BERR_EXCEPTION   1
 System error index for BIOS_Set_Error_Handler() callback.
#define BERR_CORRUPTMEMORY   2
 System error index for BIOS_Set_Error_Handler() callback.
#define BERR_TCPIPFATAL   3
 System error index for BIOS_Set_Error_Handler() callback.
#define BERR_TCPIPMEMLIMIT   4
 System error index for BIOS_Set_Error_Handler() callback.
#define BERR_TCPIPMEMALLOC   5
 System error index for BIOS_Set_Error_Handler() callback.
#define BERR_NETWORK   6
 System error index for BIOS_Set_Error_Handler() callback.
#define BERR_FLASHDEFECT   8
 System error index for BIOS_Set_Error_Handler() callback.
#define BERR_LOWMEMORY   9
 System error index for BIOS_Set_Error_Handler() callback.
#define BERR_HARDWARE   10
 System error index for BIOS_Set_Error_Handler() callback.
#define BERR_EEPROM   11
 System error index for BIOS_Set_Error_Handler() callback.
#define BERR_USB_HUB   12
 System error index for BIOS_Set_Error_Handler() callback.
#define BERR_LOWSPACE   13
 System error index for BIOS_Set_Error_Handler() callback.
#define BERR_FLASHWEAK   14
 System error index for BIOS_Set_Error_Handler() callback.
#define BERR_ASSERT_FAILED   15
 System error index for BIOS_Set_Error_Handler() callback.
#define BERR_WATCHDOG_MANAGER   16
 System error index for BIOS_Set_Error_Handler() callback.
#define BERR_DRIVER_START   1000
 First error in range for BIOS_Set_Error() driver error reporting.
#define BERR_DRIVER_GCLIB_COMM   BERR_DRIVER_START
 System error index for BIOS_Set_Error_Handler() callback.
#define BERR_APPLICATION_START   10000
 First error in range for BIOS_Set_Error() application error reporting.
#define DS_CLUSTERS_ALIGNED   (0x1)
 Bit definition for DiskStatS::dsStatusFlags.
#define DS_CLUSTERS_MISALIGNED   (0x2)
 Bit definition for DiskStatS::dsStatusFlags.

Typedefs

typedef void(* USER_ERROR_HANDLER )(int error_code)
 Deprecated user callback vector.
typedef void(* BIOS_ERROR_HANDLER )(unsigned error_code, unsigned long details)
 BIOS callback vector installed by BIOS_Set_Error_Handler().
typedef int(* USER_KBHIT )(void)
 Prototype for user specific kbhit() function.
typedef void(* USER_PUTCH )(char chr)
 Prototype for user specific putch() function.
typedef void(* USER_PUTSTR )(const char *pch, int n)
 Prototype for user specific putstr() function.
typedef int(* USER_GETCH )(void)
 Prototype for user specific getch() function.

Enumerations

enum  BiosPowerMode {
  BPM_FULL_POWER = 0,
  BPM_DYNAMIC = 1,
  BPM_DOZE = 2,
  BPM_NAP = 3,
  BPM_SLEEP = 4,
  BPM_DEEP_SLEEP = 5,
  BPM_READOUT = 99
}
 

Power mode selection enumerator.

More...
enum  STDIO_PORT {
  STDIO_UART1 = 0x01,
  STDIO_UART3 = 0x02,
  STDIO_TELNET = 0x04,
  STDIO_USER = 0x08,
  STDIO_SSH = 0x10
}
 

STDIO ports.

More...
enum  STDIO_DIRECTION {
  SET_STDOUT = 0x1,
  SET_STDIN = 0x2
}
 

STDIO directions.

More...
enum  IO_FOCUS {
  FOCUS_SHELL = 1,
  FOCUS_APPLICATION = 2,
  FOCUS_BOTH = 3
}
 

STDIO focus modes.

More...
enum  BATCH_MODE {
  BATCH_CONCURRENT = 0,
  BATCH_SEQUENTIAL = 1
}
 

Batch modes.

More...
enum  SERVER_SPEC {
  SS_FTP_SERVER = 0,
  SS_TELNET_SERVER = 1,
  SS_WEB_SERVER = 2,
  SS_SSL_WEB_SERVER = 3,
  SS_SSH_SERVER = 4,
  SS_TFTP_SERVER = 5
}
 

Internal server IDs.

More...
enum  FS_ATTRIBUTE {
  FJ_DA_NORMAL = 0x00,
  FJ_DA_RDONLY = 0x01,
  FJ_DA_HIDDEN = 0x02,
  FJ_DA_SYSTEM = 0x04,
  FJ_DA_VOLUME = 0x08,
  FJ_DA_DIRENT = 0x10,
  FJ_DA_ARCHIVE = 0x20
}
 

File attributes.

More...





Top of page | Main page

Copyright © 2017 Beck IPC GmbH
Generated on Thu Jan 26 16:21:36 2017 by Doxygen 1.6.1