1 /* 2 * Copyright (c) 2016, Linaro Limited 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 met: 7 * 8 * 1. Redistributions of source code must retain the above copyright notice, 9 * this list of conditions and the following disclaimer. 10 * 11 * 2. Redistributions in binary form must reproduce the above copyright notice, 12 * this list of conditions and the following disclaimer in the documentation 13 * and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 19 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 20 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 21 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 22 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 23 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 24 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 25 * POSSIBILITY OF SUCH DAMAGE. 26 */ 27 #ifndef __DRIVERS_SERIAL_H 28 #define __DRIVERS_SERIAL_H 29 30 #include <assert.h> 31 #include <stdbool.h> 32 #include <types_ext.h> 33 #include <mm/core_memprot.h> 34 #include <mm/core_mmu.h> 35 36 struct serial_chip { 37 const struct serial_ops *ops; 38 }; 39 40 struct serial_ops { 41 void (*putc)(struct serial_chip *chip, int ch); 42 void (*flush)(struct serial_chip *chip); 43 bool (*have_rx_data)(struct serial_chip *chip); 44 int (*getchar)(struct serial_chip *chip); 45 }; 46 47 struct io_pa_va { 48 paddr_t pa; 49 vaddr_t va; 50 }; 51 52 /* 53 * Helper function to return a physical or virtual address for a device, 54 * depending on whether the MMU is enabled or not 55 */ 56 static inline vaddr_t io_pa_or_va(struct io_pa_va *p) 57 { 58 assert(p->pa); 59 if (cpu_mmu_enabled()) { 60 if (!p->va) 61 p->va = (vaddr_t)phys_to_virt_io(p->pa); 62 assert(p->va); 63 return p->va; 64 } 65 return p->pa; 66 } 67 68 #endif /*__DRIVERS_SERIASERIAL_H*/ 69