1 /* 2 * Copyright (C) 2019 The Android Open Source Project 3 * 4 * Permission is hereby granted, free of charge, to any person 5 * obtaining a copy of this software and associated documentation 6 * files (the "Software"), to deal in the Software without 7 * restriction, including without limitation the rights to use, copy, 8 * modify, merge, publish, distribute, sublicense, and/or sell copies 9 * of the Software, and to permit persons to whom the Software is 10 * furnished to do so, subject to the following conditions: 11 * 12 * The above copyright notice and this permission notice shall be 13 * included in all copies or substantial portions of the Software. 14 * 15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 16 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 17 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 18 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS 19 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN 20 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 21 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 22 * SOFTWARE. 23 */ 24 25 #pragma once 26 27 #include <stddef.h> 28 #include <virtio-console.h> 29 30 #define MIN(x, y) (((x) < (y)) ? (x) : (y)) 31 32 /** 33 * init_log() - Enable the default logger. 34 * @console - virtio serial console device. 35 * 36 * Returns 0 if succeed to initialize logger, returns negative value 37 * otherwise. 38 */ 39 int init_log(struct virtio_console* console); 40 41 /** 42 * abort_msg() - Terminates abnormally, printing the message provided. 43 * @msg - Null-terminated string to output before dying. 44 * 45 * This function is used to indicate framework failure as opposed to test 46 * failure. For now, that is signaled by exiting with status code 2 via 47 * testrunner0 communication channel. 48 */ 49 void abort_msg(const char* msg); 50 51 /** 52 * log_msg() - Logs a null terminated string. 53 * @msg - Null terminated string to log. 54 */ 55 void log_msg(const char* msg); 56 57 /** 58 * log_buf - Logs a sized buffer. 59 * @buf - Pointer to the start of the buffer to log. 60 * @len - Size of the buffer to log. 61 * 62 * This is a more raw form of log_msg to use when, for example, relaying a 63 * message from Trusty directly into the log. 64 * 65 * Data in the buffer should be printable, this function is not intended for 66 * dumping raw buffers. 67 */ 68 void log_buf(const char* buf, size_t len); 69