Microchip® Advanced Software Framework

status_codes.h File Reference

Status code definitions.

This file defines various status codes returned by functions, indicating success or failure as well as what kind of failure.

Copyright (c) 2011-2018 Microchip Technology Inc. and its subsidiaries.

Typedefs

typedef enum status_code status_code_t
 

Enumerations

enum  status_code {
  STATUS_OK = 0,
  STATUS_ERR_BUSY = 0x19,
  STATUS_ERR_DENIED = 0x1C,
  STATUS_ERR_TIMEOUT = 0x12,
  ERR_IO_ERROR = -1,
  ERR_FLUSHED = -2,
  ERR_TIMEOUT = -3,
  ERR_BAD_DATA = -4,
  ERR_PROTOCOL = -5,
  ERR_UNSUPPORTED_DEV = -6,
  ERR_NO_MEMORY = -7,
  ERR_INVALID_ARG = -8,
  ERR_BAD_ADDRESS = -9,
  ERR_BUSY = -10,
  ERR_BAD_FORMAT = -11,
  ERR_NO_TIMER = -12,
  ERR_TIMER_ALREADY_RUNNING = -13,
  ERR_TIMER_NOT_RUNNING = -14,
  ERR_ABORTED = -15,
  OPERATION_IN_PROGRESS = -128
}
 Status code that may be returned by shell commands and protocol implementations. More...
 

typedef enum status_code status_code_t

Status code that may be returned by shell commands and protocol implementations.

Note
Any change to these status codes and the corresponding message strings is strictly forbidden. New codes can be added, however, but make sure that any message string tables are updated at the same time.
Enumerator
STATUS_OK 

Success.

STATUS_ERR_BUSY 
STATUS_ERR_DENIED 
STATUS_ERR_TIMEOUT 
ERR_IO_ERROR 

I/O error.

ERR_FLUSHED 

Request flushed from queue.

ERR_TIMEOUT 

Operation timed out.

ERR_BAD_DATA 

Data integrity check failed.

ERR_PROTOCOL 

Protocol error.

ERR_UNSUPPORTED_DEV 

Unsupported device.

ERR_NO_MEMORY 

Insufficient memory.

ERR_INVALID_ARG 

Invalid argument.

ERR_BAD_ADDRESS 

Bad address.

ERR_BUSY 

Resource is busy.

ERR_BAD_FORMAT 

Data format not recognized.

ERR_NO_TIMER 

No timer available.

ERR_TIMER_ALREADY_RUNNING 

Timer already running.

ERR_TIMER_NOT_RUNNING 

Timer not running.

ERR_ABORTED 

Operation aborted by user.

OPERATION_IN_PROGRESS 

Operation in progress.

This status code is for driver-internal use when an operation is currently being performed.

Note
Drivers should never return this status code to any callers. It is strictly for internal use.