1 /* 2 * Copyright The Mbed TLS Contributors 3 * SPDX-License-Identifier: Apache-2.0 4 * 5 * Licensed under the Apache License, Version 2.0 (the "License"); you may 6 * not use this file except in compliance with the License. 7 * You may obtain a copy of the License at 8 * 9 * http://www.apache.org/licenses/LICENSE-2.0 10 * 11 * Unless required by applicable law or agreed to in writing, software 12 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 13 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 * See the License for the specific language governing permissions and 15 * limitations under the License. 16 * 17 * This file is part of mbed TLS (https://tls.mbed.org) 18 */ 19 20 /** 21 * \file mps_error.h 22 * 23 * \brief Error codes used by MPS 24 */ 25 26 #ifndef MBEDTLS_MPS_ERROR_H 27 #define MBEDTLS_MPS_ERROR_H 28 29 30 /* TODO: The error code allocation needs to be revisited: 31 * 32 * - Should we make (some of) the MPS Reader error codes public? 33 * If so, we need to adjust MBEDTLS_MPS_READER_MAKE_ERROR() to hit 34 * a gap in the Mbed TLS public error space. 35 * If not, we have to make sure we don't forward those errors 36 * at the level of the public API -- no risk at the moment as 37 * long as MPS is an experimental component not accessible from 38 * public API. 39 */ 40 41 /** 42 * \name SECTION: MPS general error codes 43 * 44 * \{ 45 */ 46 47 #ifndef MBEDTLS_MPS_ERR_BASE 48 #define MBEDTLS_MPS_ERR_BASE (0) 49 #endif 50 51 #define MBEDTLS_MPS_MAKE_ERROR(code) \ 52 (-(MBEDTLS_MPS_ERR_BASE | (code))) 53 54 #define MBEDTLS_ERR_MPS_OPERATION_UNEXPECTED MBEDTLS_MPS_MAKE_ERROR(0x1) 55 #define MBEDTLS_ERR_MPS_INTERNAL_ERROR MBEDTLS_MPS_MAKE_ERROR(0x2) 56 57 /* \} name SECTION: MPS general error codes */ 58 59 /** 60 * \name SECTION: MPS Reader error codes 61 * 62 * \{ 63 */ 64 65 #ifndef MBEDTLS_MPS_READER_ERR_BASE 66 #define MBEDTLS_MPS_READER_ERR_BASE (1 << 8) 67 #endif 68 69 #define MBEDTLS_MPS_READER_MAKE_ERROR(code) \ 70 (-(MBEDTLS_MPS_READER_ERR_BASE | (code))) 71 72 /*! An attempt to reclaim the data buffer from a reader failed because 73 * the user hasn't yet read and committed all of it. */ 74 #define MBEDTLS_ERR_MPS_READER_DATA_LEFT MBEDTLS_MPS_READER_MAKE_ERROR(0x1) 75 76 /*! An invalid argument was passed to the reader. */ 77 #define MBEDTLS_ERR_MPS_READER_INVALID_ARG MBEDTLS_MPS_READER_MAKE_ERROR(0x2) 78 79 /*! An attempt to move a reader to consuming mode through mbedtls_mps_reader_feed() 80 * after pausing failed because the provided data is not sufficient to serve the 81 * read requests that led to the pausing. */ 82 #define MBEDTLS_ERR_MPS_READER_NEED_MORE MBEDTLS_MPS_READER_MAKE_ERROR(0x3) 83 84 /*! A get request failed because not enough data is available in the reader. */ 85 #define MBEDTLS_ERR_MPS_READER_OUT_OF_DATA MBEDTLS_MPS_READER_MAKE_ERROR(0x4) 86 87 /*!< A get request after pausing and reactivating the reader failed because 88 * the request is not in line with the request made prior to pausing. The user 89 * must not change it's 'strategy' after pausing and reactivating a reader. */ 90 #define MBEDTLS_ERR_MPS_READER_INCONSISTENT_REQUESTS MBEDTLS_MPS_READER_MAKE_ERROR(0x5) 91 92 /*! An attempt to reclaim the data buffer from a reader failed because the reader 93 * has no accumulator it can use to backup the data that hasn't been processed. */ 94 #define MBEDTLS_ERR_MPS_READER_NEED_ACCUMULATOR MBEDTLS_MPS_READER_MAKE_ERROR(0x6) 95 96 /*! An attempt to reclaim the data buffer from a reader failed because the 97 * accumulator passed to the reader is not large enough to hold both the 98 * data that hasn't been processed and the excess of the last read-request. */ 99 #define MBEDTLS_ERR_MPS_READER_ACCUMULATOR_TOO_SMALL MBEDTLS_MPS_READER_MAKE_ERROR(0x7) 100 101 /* \} name SECTION: MPS Reader error codes */ 102 103 #endif /* MBEDTLS_MPS_ERROR_H */ 104
