Xmega Application Note


status_codes.h File Reference

Status code definitions. More...

Go to the source code of this file.

Typedefs

typedef enum status_code status_code_t

Enumerations

enum  status_code {
  STATUS_OK = 0, 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,
  OPERATION_IN_PROGRESS = -128
}

Detailed Description

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) 2009 Atmel Corporation. All rights reserved.

Definition in file status_codes.h.


Typedef Documentation

typedef enum status_code status_code_t

Definition at line 79 of file status_codes.h.


Enumeration Type Documentation

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.

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.

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.

Definition at line 53 of file status_codes.h.

00053                  {
00054         STATUS_OK               =     0, 
00055         ERR_IO_ERROR            =    -1, 
00056         ERR_FLUSHED             =    -2, 
00057         ERR_TIMEOUT             =    -3, 
00058         ERR_BAD_DATA            =    -4, 
00059         ERR_PROTOCOL            =    -5, 
00060         ERR_UNSUPPORTED_DEV     =    -6, 
00061         ERR_NO_MEMORY           =    -7, 
00062         ERR_INVALID_ARG         =    -8, 
00063         ERR_BAD_ADDRESS         =    -9, 
00064         ERR_BUSY                =   -10, 
00065         ERR_BAD_FORMAT          =   -11, 
00066 
00076         OPERATION_IN_PROGRESS   = -128,
00077 };

@DOC_TITLE@
Generated on Fri Oct 22 12:15:25 2010 for AVR1300 Using the Xmega ADC by doxygen 1.6.3