Serial Wombat 4A and 4B Firmware
serialWombatErrors.h
Go to the documentation of this file.
1 /*
2 Copyright 2020-2021 Broadwell Consulting Inc.
3 
4 Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10 
11 The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13 
14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
17  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
18  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20  * OTHER DEALINGS IN THE SOFTWARE.
21 */
22 #ifndef _SERIAL_WOMBAT_ERROR_
23 #define _SERIAL_WOMBAT_ERROR_
24 typedef enum {
69  SW_ERROR_UNKNOWN_OUTPUTSCALE_COMMAND = 44, // The command index for an output scaling command is not supported on this firmware
70  SW_ERROR_UNKNOWN_INPUT_PROCESS_COMMAND = 45, // The command index for an inputProcess command is not supported on this firmware
71  SW_ERROR_PULSE_ON_CHANGE_ENTRY_OUT_OF_RANGE = 46, // The pulse on change entry number exceeded the number of entries
72  SW_ERROR_PULSE_ON_CHANGE_UNKNOWN_MODE = 47, // The pulse on change Mode requested is unknown
73  SW_ERROR_UNKNOWN_QUEUE_TYPE = 48, // This Queue type is not supported on this firwmare
74 }SW_ERROR_t;
75 
76 #endif
SW_ERROR_UNKNOWN_INPUT_PROCESS_COMMAND
@ SW_ERROR_UNKNOWN_INPUT_PROCESS_COMMAND
Definition: serialWombatErrors.h:70
SW_ERROR_t
SW_ERROR_t
Definition: serialWombatErrors.h:24
SW_ERROR_INVALID_PARAMETER_3
@ SW_ERROR_INVALID_PARAMETER_3
The pin configuration parameter in Byte 3 was invalid.
Definition: serialWombatErrors.h:42
SW_ERROR_2ND_INF_UNAVAILABLE
@ SW_ERROR_2ND_INF_UNAVAILABLE
The 2nd interface hardware was not avaialble to claim.
Definition: serialWombatErrors.h:51
SW_ERROR_UNKNOWN_PIN_MODE
@ SW_ERROR_UNKNOWN_PIN_MODE
A Pin mode was indicated that is not avaialble on this model or version of Serial Wombat chip.
Definition: serialWombatErrors.h:28
SW_ERROR_QUEUE_RESULT_UNALIGNED_ADDRESS
@ SW_ERROR_QUEUE_RESULT_UNALIGNED_ADDRESS
Definition: serialWombatErrors.h:62
SW_ERROR_HW_RESOURCE_IN_USE
@ SW_ERROR_HW_RESOURCE_IN_USE
The requested hardware or software resource in use has already been exclusively claimed by another pi...
Definition: serialWombatErrors.h:41
SW_ERROR_INVALID_PARAMETER_6
@ SW_ERROR_INVALID_PARAMETER_6
The pin configuration parameter in Byte 6 was invalid.
Definition: serialWombatErrors.h:45
SW_ERROR_TM1637_WRONG_MODE
@ SW_ERROR_TM1637_WRONG_MODE
The TM1637 pin is configured for the wrong TM1637 mode to process the command.
Definition: serialWombatErrors.h:67
SW_ERROR_UNKNOWN_OUTPUTSCALE_COMMAND
@ SW_ERROR_UNKNOWN_OUTPUTSCALE_COMMAND
Definition: serialWombatErrors.h:69
SW_ERROR_PIN_NUMBER_TOO_HIGH
@ SW_ERROR_PIN_NUMBER_TOO_HIGH
The pin number indicated was greater than the greatest avaialable pin.
Definition: serialWombatErrors.h:47
SW_ERROR_CMD_BYTE_7
@ SW_ERROR_CMD_BYTE_7
Byte 7 of the command was invalid.
Definition: serialWombatErrors.h:59
SW_ERROR_CMD_BYTE_5
@ SW_ERROR_CMD_BYTE_5
Byte 5 of the command was invalid.
Definition: serialWombatErrors.h:57
SW_ERROR_UNKNOWN_QUEUE_TYPE
@ SW_ERROR_UNKNOWN_QUEUE_TYPE
Definition: serialWombatErrors.h:73
SW_ERROR_INVALID_PARAMETER_7
@ SW_ERROR_INVALID_PARAMETER_7
The pin configuration parameter in Byte 7 was invalid.
Definition: serialWombatErrors.h:46
SW_ERROR_INVALID_PIN_COMMAND
@ SW_ERROR_INVALID_PIN_COMMAND
The pin command 0xC1, 0xC2, etc is not suported by this pin mode (May vary by model)
Definition: serialWombatErrors.h:37
SW_ERROR_PULSE_ON_CHANGE_ENTRY_OUT_OF_RANGE
@ SW_ERROR_PULSE_ON_CHANGE_ENTRY_OUT_OF_RANGE
Definition: serialWombatErrors.h:71
SW_ERROR_RUB_INVALID_ADDRESS
@ SW_ERROR_RUB_INVALID_ADDRESS
An attempt to read user buffer address outside the user buffer was attempted.
Definition: serialWombatErrors.h:68
SW_ERROR_CMD_UNSUPPORTED_BAUD_RATE
@ SW_ERROR_CMD_UNSUPPORTED_BAUD_RATE
invalid baud rate enumeration
Definition: serialWombatErrors.h:60
SW_ERROR_CMD_BYTE_6
@ SW_ERROR_CMD_BYTE_6
Byte 6 of the command was invalid.
Definition: serialWombatErrors.h:58
SW_ERROR_INSUFFICIENT_SPACE
@ SW_ERROR_INSUFFICIENT_SPACE
There was not sufficient space in the queue or user area to complete the command.
Definition: serialWombatErrors.h:31
SW_ERROR_UNNUMBERED_ERROR
@ SW_ERROR_UNNUMBERED_ERROR
Definition: serialWombatErrors.h:25
SW_ERROR_WUB_COUNT_GT_4
@ SW_ERROR_WUB_COUNT_GT_4
A count greater than 4 was provided as a number of bytes to write to count user buffer.
Definition: serialWombatErrors.h:32
SW_ERROR_WUB_INVALID_ADDRESS
@ SW_ERROR_WUB_INVALID_ADDRESS
An attempt to write to a user buffer address outside the user buffer was attempted.
Definition: serialWombatErrors.h:33
SW_ERROR_WUB_CONTINUE_OUTOFBOUNDS
@ SW_ERROR_WUB_CONTINUE_OUTOFBOUNDS
A call to Write User Buffer Continue would have written out of bounds.
Definition: serialWombatErrors.h:34
SW_ERROR_FLASH_WRITE_INVALID_ADDRESS
@ SW_ERROR_FLASH_WRITE_INVALID_ADDRESS
An attempt to write or erase flash was made to a protected or non-existant area.
Definition: serialWombatErrors.h:36
SW_ERROR_CMD_BYTE_1
@ SW_ERROR_CMD_BYTE_1
Byte 1 of the command was invalid.
Definition: serialWombatErrors.h:53
SW_ERROR_QUEUE_RESULT_EMPTY
@ SW_ERROR_QUEUE_RESULT_EMPTY
Definition: serialWombatErrors.h:65
SW_ERROR_UART_NOT_INITIALIZED
@ SW_ERROR_UART_NOT_INITIALIZED
A UART operation was requested but the UART was not intialized.
Definition: serialWombatErrors.h:52
SW_ERROR_INVALID_PARAMETER_5
@ SW_ERROR_INVALID_PARAMETER_5
The pin configuration parameter in Byte 5 was invalid.
Definition: serialWombatErrors.h:44
SW_ERROR_QUEUE_RESULT_INVALID_QUEUE
@ SW_ERROR_QUEUE_RESULT_INVALID_QUEUE
Definition: serialWombatErrors.h:63
SW_ERROR_PIN_NOT_CAPABLE
@ SW_ERROR_PIN_NOT_CAPABLE
The commanded pin does not have the hardware support to perform the commanded pin mode.
Definition: serialWombatErrors.h:40
SW_ERROR_CMD_BYTE_3
@ SW_ERROR_CMD_BYTE_3
Byte 3 of the command was invalid.
Definition: serialWombatErrors.h:55
SW_ERROR_DATA_NOT_AVAILABLE
@ SW_ERROR_DATA_NOT_AVAILABLE
Definition: serialWombatErrors.h:66
SW_ERROR_CMD_BYTE_2
@ SW_ERROR_CMD_BYTE_2
Byte 2 of the command was invalid.
Definition: serialWombatErrors.h:54
SW_ERROR_ASCII_NUMBER_TOO_BIG_16
@ SW_ERROR_ASCII_NUMBER_TOO_BIG_16
A number bigger than 65535 was provided to convert to a 16 bit value.
Definition: serialWombatErrors.h:27
SW_ERROR_RESET_STRING_INCORRECT
@ SW_ERROR_RESET_STRING_INCORRECT
A Packet starting with 'R' was received but didn't have the correct following bytes to cause a reset.
Definition: serialWombatErrors.h:29
SW_ERROR_CMD_BYTE_4
@ SW_ERROR_CMD_BYTE_4
Byte 4 of the command was invalid.
Definition: serialWombatErrors.h:56
SW_ERROR_2ND_INF_WRONG_UNLOCK
@ SW_ERROR_2ND_INF_WRONG_UNLOCK
The unlock value provided to enable the 2nd interface was incorrect.
Definition: serialWombatErrors.h:50
SW_ERROR_QUEUE_RESULT_FULL
@ SW_ERROR_QUEUE_RESULT_FULL
Definition: serialWombatErrors.h:64
SW_ERROR_WS2812_INDEX_GT_LEDS
@ SW_ERROR_WS2812_INDEX_GT_LEDS
The command references an index that is greater or equal to the number of leds.
Definition: serialWombatErrors.h:39
SW_ERROR_ANALOG_CAL_WRONG_UNLOCK
@ SW_ERROR_ANALOG_CAL_WRONG_UNLOCK
The unlock value provided to write analog calibration was incorrect.
Definition: serialWombatErrors.h:49
SW_ERROR_PINS_MUST_BE_ON_SAME_PORT
@ SW_ERROR_PINS_MUST_BE_ON_SAME_PORT
Pins must be on the same microcontroller part (e.g. PORTA, PORTB, etc.). See datasheet of micro for p...
Definition: serialWombatErrors.h:26
SW_ERROR_PIN_IS_COMM_INTERFACE
@ SW_ERROR_PIN_IS_COMM_INTERFACE
The pin number indicated is currently being used for Serial Wombat protocol communicaitons.
Definition: serialWombatErrors.h:48
SW_ERROR_RF_ODD_ADDRESS
@ SW_ERROR_RF_ODD_ADDRESS
Addresses Read From Flash must be even.
Definition: serialWombatErrors.h:35
SW_ERROR_PULSE_ON_CHANGE_UNKNOWN_MODE
@ SW_ERROR_PULSE_ON_CHANGE_UNKNOWN_MODE
Definition: serialWombatErrors.h:72
SW_ERROR_QUEUE_RESULT_INSUFFICIENT_USER_SPACE
@ SW_ERROR_QUEUE_RESULT_INSUFFICIENT_USER_SPACE
Definition: serialWombatErrors.h:61
SW_ERROR_PIN_CONFIG_WRONG_ORDER
@ SW_ERROR_PIN_CONFIG_WRONG_ORDER
The called pin command 0xC1, 0xC2 was called before other required prior commands (e....
Definition: serialWombatErrors.h:38
SW_ERROR_INVALID_COMMAND
@ SW_ERROR_INVALID_COMMAND
The first byte of a received packet does not correspond with a command supported by this model of Ser...
Definition: serialWombatErrors.h:30
SW_ERROR_INVALID_PARAMETER_4
@ SW_ERROR_INVALID_PARAMETER_4
The pin configuration parameter in Byte 4 was invalid.
Definition: serialWombatErrors.h:43