Sol Boucher | 65d9520 | 2015-02-27 17:07:30 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2010, Google Inc. |
| 3 | * All rights reserved. |
| 4 | * |
| 5 | * Redistribution and use in source and binary forms, with or without |
| 6 | * modification, are permitted provided that the following conditions are |
| 7 | * met: |
| 8 | * |
| 9 | * * Redistributions of source code must retain the above copyright |
| 10 | * notice, this list of conditions and the following disclaimer. |
| 11 | * * Redistributions in binary form must reproduce the above |
| 12 | * copyright notice, this list of conditions and the following disclaimer |
| 13 | * in the documentation and/or other materials provided with the |
| 14 | * distribution. |
| 15 | * * Neither the name of Google Inc. nor the names of its |
| 16 | * contributors may be used to endorse or promote products derived from |
| 17 | * this software without specific prior written permission. |
| 18 | * |
| 19 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| 20 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| 21 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| 22 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| 23 | * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| 24 | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| 25 | * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| 26 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| 27 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| 28 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| 29 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 30 | */ |
| 31 | |
| 32 | #ifndef FLASHMAP_LIB_VALSTR_H__ |
| 33 | #define FLASHMAP_LIB_VALSTR_H__ |
| 34 | |
| 35 | #include <inttypes.h> |
| 36 | |
| 37 | /* value + string structure for common conversions */ |
| 38 | struct valstr { |
| 39 | uint32_t val; /* field value */ |
| 40 | const char *str; /* field description */ |
| 41 | }; |
| 42 | |
| 43 | /* |
| 44 | * val2str_default - convert value to string |
| 45 | * |
Sol Boucher | fa7a455 | 2015-05-07 16:41:46 -0700 | [diff] [blame] | 46 | * @val: value to convert |
| 47 | * @vs: value-string data |
| 48 | * @def_str: default string to return if no matching value found |
Sol Boucher | 65d9520 | 2015-02-27 17:07:30 -0800 | [diff] [blame] | 49 | * |
| 50 | * returns pointer to string |
| 51 | * returns def_str if no matching value found |
| 52 | */ |
| 53 | const char *val2str_default(uint32_t val, const struct valstr *vs, |
Sol Boucher | fa7a455 | 2015-05-07 16:41:46 -0700 | [diff] [blame] | 54 | const char *def_str); |
Sol Boucher | 65d9520 | 2015-02-27 17:07:30 -0800 | [diff] [blame] | 55 | |
| 56 | /* |
| 57 | * val2str - convert value to string |
| 58 | * |
Sol Boucher | fa7a455 | 2015-05-07 16:41:46 -0700 | [diff] [blame] | 59 | * @val: value to convert |
| 60 | * @vs: value-string data |
Sol Boucher | 65d9520 | 2015-02-27 17:07:30 -0800 | [diff] [blame] | 61 | * |
| 62 | * returns pointer to string |
| 63 | * returns pointer to "unknown" static string if not found |
| 64 | */ |
| 65 | const char *val2str(uint32_t val, const struct valstr *vs); |
| 66 | |
| 67 | /* |
| 68 | * str2val - convert string to value |
| 69 | * |
Sol Boucher | fa7a455 | 2015-05-07 16:41:46 -0700 | [diff] [blame] | 70 | * @str: string to convert |
| 71 | * @vs: value-string data |
Sol Boucher | 65d9520 | 2015-02-27 17:07:30 -0800 | [diff] [blame] | 72 | * |
| 73 | * returns value for string |
| 74 | * returns value for last entry in value-string data if not found |
| 75 | */ |
| 76 | uint32_t str2val(const char *str, const struct valstr *vs); |
| 77 | |
| 78 | #endif /* FLASHMAP_LIB_VALSTR_H__ */ |