Subversion Repositories HelenOS

Rev

Rev 3674 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

  1. /*
  2.  * Copyright (c) 2008 Pavel Rimsky
  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
  7.  * are 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 copyright
  12.  *   notice, this list of conditions and the following disclaimer in the
  13.  *   documentation and/or other materials provided with the distribution.
  14.  * - The name of the author may not be used to endorse or promote products
  15.  *   derived from this software without specific prior written permission.
  16.  *
  17.  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18.  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20.  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21.  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22.  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26.  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27.  */
  28.  
  29. /** @addtogroup sparc64
  30.  * @{
  31.  */
  32. /** @file
  33.  */
  34.  
  35. #ifndef KERN_sparc64_SGCN_H_
  36. #define KERN_sparc64_SGCN_H_
  37.  
  38. #include <arch/types.h>
  39. #include <console/chardev.h>
  40.  
  41. /* number of bytes in the TOC magic, including the terminating '\0' */
  42. #define TOC_MAGIC_BYTES     8
  43.  
  44. /* number of bytes in the TOC key, including the terminating '\0' */
  45. #define TOC_KEY_SIZE        8
  46.  
  47. /* maximum number of entries in the SRAM table of contents */
  48. #define MAX_TOC_ENTRIES     32
  49.  
  50. /* number of bytes in the SGCN buffer magic, including the terminating '\0' */
  51. #define SGCN_MAGIC_BYTES    4
  52.  
  53. /**
  54.  * Entry in the SRAM table of contents. Describes one segment of the SRAM
  55.  * which serves a particular purpose (e.g. OBP serial console, Solaris serial
  56.  * console, Solaris mailbox,...).
  57.  */
  58. typedef struct {
  59.     /** key (e.g. "OBPCONS", "SOLCONS", "SOLMBOX",...) */
  60.     char key[TOC_KEY_SIZE];
  61.    
  62.     /** size of the segment in bytes */
  63.     uint32_t size;
  64.    
  65.     /** offset of the segment within SRAM */
  66.     uint32_t offset;
  67. } __attribute ((packed)) toc_entry_t;
  68.  
  69. /**
  70.  * SRAM table of contents. Describes all segments within the SRAM.
  71.  */
  72. typedef struct {
  73.     /** hard-wired to "TOCSRAM" */
  74.     char magic[TOC_MAGIC_BYTES];
  75.    
  76.     /** we don't need this */
  77.     char unused[8];
  78.    
  79.     /** TOC entries */
  80.     toc_entry_t keys[MAX_TOC_ENTRIES];
  81. } __attribute__ ((packed)) iosram_toc_t;
  82.  
  83. /**
  84.  * SGCN buffer header. It is placed at the very beginning of the SGCN
  85.  * buffer.
  86.  */
  87. typedef struct {
  88.     /** hard-wired to "CON" */
  89.     char magic[SGCN_MAGIC_BYTES];
  90.    
  91.     /** we don't need this */
  92.     char unused[8];
  93.    
  94.     /** offset within the SGCN buffer of the input buffer start */
  95.     uint32_t in_begin;
  96.    
  97.     /** offset within the SGCN buffer of the input buffer end */
  98.     uint32_t in_end;
  99.    
  100.     /** offset within the SGCN buffer of the input buffer read pointer */
  101.     uint32_t in_rdptr;
  102.    
  103.     /** offset within the SGCN buffer of the input buffer write pointer */
  104.     uint32_t in_wrptr;
  105.  
  106.     /** offset within the SGCN buffer of the output buffer start */
  107.     uint32_t out_begin;
  108.    
  109.     /** offset within the SGCN buffer of the output buffer end */
  110.     uint32_t out_end;
  111.    
  112.     /** offset within the SGCN buffer of the output buffer read pointer */
  113.     uint32_t out_rdptr;
  114.    
  115.     /** offset within the SGCN buffer of the output buffer write pointer */
  116.     uint32_t out_wrptr;
  117. } __attribute__ ((packed)) sgcn_buffer_header_t;
  118.  
  119. void sgcn_grab(void);
  120. void sgcn_release(void);
  121. indev_t *sgcnin_init(void);
  122. void sgcnout_init(void);
  123.  
  124. #endif
  125.  
  126. /** @}
  127.  */
  128.