Skip to content

Commit 56c29b4

Browse files
singalsulgirdwood
authored andcommitted
Audio: ASRC: Reformat header file comments with longer lines
The 80 characters split lines were hard to read. This change improves readability error codes enums. Signed-off-by: Seppo Ingalsuo <seppo.ingalsuo@linux.intel.com>
1 parent ecbb8c4 commit 56c29b4

1 file changed

Lines changed: 18 additions & 34 deletions

File tree

src/include/sof/audio/asrc/asrc_farrow.h

Lines changed: 18 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -110,41 +110,25 @@ enum asrc_operation_mode {
110110
*/
111111
enum asrc_error_code {
112112
ASRC_EC_OK = 0, /*!< Operation successful. */
113-
ASRC_EC_INIT_FAILED = -1, /*!< Initialization of the */
114-
/*!< component failed. */
115-
ASRC_EC_UPDATE_FS_FAILED = -2, /*!< Control mode is set to */
116-
/*!< CM_FIXED and update */
117-
/*!< drift is not called in */
118-
/*!< time. */
119-
ASRC_EC_INVALID_POINTER = -3, /*!< Couldn't allocate */
120-
/*!< memory. Bad pointer. */
121-
ASRC_EC_INVALID_BUFFER_POINTER = -4, /*!< Internal buffer pointers */
122-
/*!< are invalid. */
123-
ASRC_EC_INVALID_SAMPLE_RATE = -5, /*!< Sample rate is not */
124-
/*!< supported. */
125-
ASRC_EC_INVALID_CONVERSION_RATIO = -6, /*!< Conversion ratio is not */
126-
/*!< supported. */
127-
ASRC_EC_INVALID_BIT_DEPTH = -7, /*!< Bit depth is not */
128-
/*!< supported. Choose either */
113+
ASRC_EC_INIT_FAILED = -1, /*!< Initialization of the component failed. */
114+
ASRC_EC_UPDATE_FS_FAILED = -2, /*!< Control mode is set to CM_FIXED and update */
115+
/*!< drift is not called in time. */
116+
ASRC_EC_INVALID_POINTER = -3, /*!< Couldn't allocate memory. Bad pointer. */
117+
ASRC_EC_INVALID_BUFFER_POINTER = -4, /*!< Internal buffer pointers are invalid. */
118+
ASRC_EC_INVALID_SAMPLE_RATE = -5, /*!< Sample rate is not supported. */
119+
ASRC_EC_INVALID_CONVERSION_RATIO = -6, /*!< Conversion ratio is not supported. */
120+
ASRC_EC_INVALID_BIT_DEPTH = -7, /*!< Bit depth is not supported. Choose either */
129121
/*!< 16 or 32 bit. */
130-
ASRC_EC_INVALID_NUM_CHANNELS = -8, /*!< Nummber of channels must */
131-
/*!< be larger than zero. */
132-
ASRC_EC_INVALID_BUFFER_LENGTH = -9, /*!< Buffer length must be */
133-
/*!< larger than one. */
134-
ASRC_EC_INVALID_FRAME_SIZE = -10, /*!< Invalid frame size: must */
135-
/*!< be greater than 0 for */
136-
/*!< primary side and */
137-
/*!< secondary side. */
138-
ASRC_EC_INVALID_CLOCK_SKEW = -11, /*!< The clock drift is out */
139-
/*!< of bounds. */
140-
ASRC_EC_INVALID_CONTROL_MODE = -12, /*!< Call update_fs_ratio() */
141-
/*!< for feedback, and */
142-
/*!< update_drift() for fixed */
143-
/*!< control mode. */
144-
ASRC_EC_FAILED_PUSH_MODE = -13, /*!< Push mode operation */
145-
/*!< failed. */
146-
ASRC_EC_FAILED_PULL_MODE = -14, /*!< Pull mode operation */
147-
/*!< failed. */
122+
ASRC_EC_INVALID_NUM_CHANNELS = -8, /*!< Nummber of channels must be larger */
123+
/*!< than zero. */
124+
ASRC_EC_INVALID_BUFFER_LENGTH = -9, /*!< Buffer length must be larger than one. */
125+
ASRC_EC_INVALID_FRAME_SIZE = -10, /*!< Invalid frame size: must be greater than 0 */
126+
/*!< for primary side and secondary side. */
127+
ASRC_EC_INVALID_CLOCK_SKEW = -11, /*!< The clock drift is out of bounds. */
128+
ASRC_EC_INVALID_CONTROL_MODE = -12, /*!< Call update_fs_ratio() for feedback, and */
129+
/*!< update_drift() for fixed control mode. */
130+
ASRC_EC_FAILED_PUSH_MODE = -13, /*!< Push mode operation failed. */
131+
ASRC_EC_FAILED_PULL_MODE = -14, /*!< Pull mode operation failed. */
148132
ASRC_EC_INVALID_FILTER_LENGTH = -15, /*!< Length exceeds max. */
149133
};
150134

0 commit comments

Comments
 (0)