Subversion Repositories HelenOS

Rev

Rev 4346 | 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.  
  40. /* number of bytes in the TOC magic, including the terminating '\0' */
  41. #define TOC_MAGIC_BYTES     8
  42.  
  43. /* number of bytes in the TOC key, including the terminating '\0' */
  44. #define TOC_KEY_SIZE        8
  45.  
  46. /* maximum number of entries in the SRAM table of contents */
  47. #define MAX_TOC_ENTRIES     32
  48.  
  49. /* number of bytes in the SGCN buffer magic, including the terminating '\0' */
  50. #define SGCN_MAGIC_BYTES    4
  51.  
  52. /**
  53.  * Entry in the SRAM table of contents. Describes one segment of the SRAM
  54.  * which serves a particular purpose (e.g. OBP serial console, Solaris serial
  55.  * console, Solaris mailbox,...).
  56.  */
  57. typedef struct {
  58.     /** key (e.g. "OBPCONS", "SOLCONS", "SOLMBOX",...) */
  59.     char key[TOC_KEY_SIZE];
  60.    
  61.     /** size of the segment in bytes */
  62.     uint32_t size;
  63.    
  64.     /** offset of the segment within SRAM */
  65.     uint32_t offset;
  66. } __attribute ((packed)) toc_entry_t;
  67.  
  68. /**
  69.  * SRAM table of contents. Describes all segments within the SRAM.
  70.  */
  71. typedef struct {
  72.     /** hard-wired to "TOCSRAM" */
  73.     char magic[TOC_MAGIC_BYTES];
  74.    
  75.     /** we don't need this */
  76.     char unused[8];
  77.    
  78.     /** TOC entries */
  79.     toc_entry_t keys[MAX_TOC_ENTRIES];
  80. } __attribute__ ((packed)) iosram_toc_t;
  81.  
  82. /**
  83.  * SGCN buffer header. It is placed at the very beginning of the SGCN
  84.  * buffer.
  85.  */
  86. typedef struct {
  87.     /** hard-wired to "CON" */
  88.     char magic[SGCN_MAGIC_BYTES];
  89.    
  90.     /** we don't need this */
  91.     char unused[8];
  92.    
  93.     /** offset within the SGCN buffer of the input buffer start */
  94.     uint32_t in_begin;
  95.    
  96.     /** offset within the SGCN buffer of the input buffer end */
  97.     uint32_t in_end;
  98.    
  99.     /** offset within the SGCN buffer of the input buffer read pointer */
  100.     uint32_t in_rdptr;
  101.    
  102.     /** offset within the SGCN buffer of the input buffer write pointer */
  103.     uint32_t in_wrptr;
  104.  
  105.     /** offset within the SGCN buffer of the output buffer start */
  106.     uint32_t out_begin;
  107.    
  108.     /** offset within the SGCN buffer of the output buffer end */
  109.     uint32_t out_end;
  110.    
  111.     /** offset within the SGCN buffer of the output buffer read pointer */
  112.     uint32_t out_rdptr;
  113.    
  114.     /** offset within the SGCN buffer of the output buffer write pointer */
  115.     uint32_t out_wrptr;
  116. } __attribute__ ((packed)) sgcn_buffer_header_t;
  117.  
  118. void sgcn_grab(void);
  119. void sgcn_release(void);
  120. void sgcn_poll(void);
  121. void sgcn_init(void);
  122.  
  123. #endif
  124.  
  125. /** @}
  126.  */
  127.