com1shell.h File Reference

#include "FreeRTOS.h"
#include "fs_com.h"
#include "supervisor.h"

Functions
signed portBASE_TYPE	com1shell_GetChar (signed portCHAR *pcByte)
	Get a char from the COM1 port. More...
void	v_com1shell_mount_local_drive (void)
	Mount default local drive 'a:'. More...
void	v_com1shell_stopResources (void)
	Stop the com1shell module resources. More...
void	vcom1shell_PrintMsg (const signed portCHAR *pcString)
	Print a string to the COM1 port. More...
void	vcom1shell_PutChar (signed portCHAR cByte)
	Put a char to the COM1 port. More...
void	vStartCom1Shell (unsigned portBASE_TYPE uxPriority)
eStatus	xCom1Shell_GetStatus (void)
	Return the status of the COM1 shell module. More...

signed portBASE_TYPE com1shell_GetChar

(

signed portCHAR *

pcByte

)

Get a char from the COM1 port.

Parameters

pcByte

Output. The char received from the COM1 port.

References COM1SHELL_RX_BLOCK_TIME, xComPort1Hndl, and xUsartGetChar().

Referenced by prv_GetChar_From_Requester_Stream().

void v_com1shell_mount_local_drive

(

void

)

Mount default local drive 'a:'.

References fsaccess_give_mutex(), fsaccess_take_mutex(), LUN_ID_AT45DBX_MEM, nav_drive_set(), nav_partition_mount(), nav_select(), and sCom1ShellNavId.

Referenced by prv_v_leave_maintenance_mode(), and vStartCom1Shell().

void v_com1shell_stopResources

(

void

)

Stop the com1shell module resources.

References vSerialClose(), and xComPort1Hndl.

Referenced by e_syscmds_reboot().

void vcom1shell_PrintMsg

(

const signed portCHAR *

pcString

)

Print a string to the COM1 port.

Parameters

pcString

Input. The string to print.

References usUsartPutString(), and xComPort1Hndl.

Referenced by portTASK_FUNCTION(), prv_Print_String_To_Requester_Stream(), prvGetCmdLine(), and v_shell_Print_String_To_Requester_Stream().

void vcom1shell_PutChar

(

signed portCHAR

cByte

)

Put a char to the COM1 port.

Parameters

cByte

Input. The char to print.

References COM1SHELL_NO_BLOCK, xComPort1Hndl, and xUsartPutChar().

Referenced by prv_PutChar_To_Requester_Stream(), and prvGetCmdLine().

void vStartCom1Shell

(

unsigned portBASE_TYPE

uxPriority

)

Start the COM1 shell module.

Parameters

uxPriority

The priority base of the COM1 shell tasks.

References COM1SHELL_STACK_SIZE, fsaccess_alloc_nav_id(), fsaccess_give_mutex(), fsaccess_take_mutex(), NULL, pdPASS, sCom1ShellNavId, SYS_STATUS_DOWN, SYS_STATUS_STARTUP, v_com1shell_mount_local_drive(), xCom1ShellHndl, xCom1ShellStatus, and xTaskCreate.

Referenced by portTASK_FUNCTION().

eStatus xCom1Shell_GetStatus

(

void

)

Return the status of the COM1 shell module.

Return the status of the COM1 shell module.

Returns

one of the eStatus enum value.

one of the eStatus enum value.

References xCom1ShellStatus.