Subversion Repositories HelenOS

Rev

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

  1. /*
  2.  * Copyright (c) 2006 Ondrej Palkovsky
  3.  * Copyright (c) 2008 Martin Decky
  4.  * Copyright (c) 2008 Pavel Rimsky
  5.  * All rights reserved.
  6.  *
  7.  * Redistribution and use in source and binary forms, with or without
  8.  * modification, are permitted provided that the following conditions
  9.  * are met:
  10.  *
  11.  * - Redistributions of source code must retain the above copyright
  12.  *   notice, this list of conditions and the following disclaimer.
  13.  * - Redistributions in binary form must reproduce the above copyright
  14.  *   notice, this list of conditions and the following disclaimer in the
  15.  *   documentation and/or other materials provided with the distribution.
  16.  * - The name of the author may not be used to endorse or promote products
  17.  *   derived from this software without specific prior written permission.
  18.  *
  19.  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  20.  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  21.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  22.  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  23.  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  24.  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  28.  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29.  */
  30.  
  31. /**
  32.  * @defgroup serial Serial console
  33.  * @brief    Serial console services (putc, puts, clear screen, cursor goto,...)
  34.  * @{
  35.  */
  36.  
  37. /** @file
  38.  */
  39.  
  40. #include <stdio.h>
  41. #include <ipc/ipc.h>
  42. #include <async.h>
  43. #include <ipc/fb.h>
  44. #include <bool.h>
  45. #include <errno.h>
  46. #include <console/color.h>
  47. #include <console/style.h>
  48.  
  49. #include "../console/screenbuffer.h"
  50. #include "main.h"
  51. #include "serial_console.h"
  52.  
  53. #define MAX_CONTROL 20
  54.  
  55. static void serial_sgr(const unsigned int mode);
  56.  
  57. static int scr_width;
  58. static int scr_height;
  59. static bool color = true;   /** True if producing color output. */
  60. static putc_function_t putc_function;
  61.  
  62. /* Allow only 1 connection */
  63. static int client_connected = 0;
  64.  
  65. enum sgr_color_index {
  66.     CI_BLACK    = 0,
  67.     CI_RED      = 1,
  68.     CI_GREEN    = 2,
  69.     CI_BROWN    = 3,
  70.     CI_BLUE     = 4,
  71.     CI_MAGENTA  = 5,
  72.     CI_CYAN     = 6,
  73.     CI_WHITE    = 7,
  74. };
  75.  
  76. enum sgr_command {
  77.     SGR_RESET   = 0,
  78.     SGR_BOLD    = 1,
  79.     SGR_BLINK   = 5,
  80.     SGR_REVERSE = 7,
  81.     SGR_NORMAL_INT  = 22,
  82.     SGR_BLINK_OFF   = 25,
  83.     SGR_REVERSE_OFF = 27,
  84.     SGR_FGCOLOR = 30,
  85.     SGR_BGCOLOR = 40
  86. };
  87.  
  88. static int color_map[] = {
  89.     [COLOR_BLACK]   = CI_BLACK,
  90.     [COLOR_BLUE]    = CI_RED,
  91.     [COLOR_GREEN]   = CI_GREEN,
  92.     [COLOR_CYAN]    = CI_CYAN,
  93.     [COLOR_RED] = CI_RED,
  94.     [COLOR_MAGENTA] = CI_MAGENTA,
  95.     [COLOR_YELLOW]  = CI_BROWN,
  96.     [COLOR_WHITE]   = CI_WHITE
  97. };
  98.  
  99. void serial_puts(char *str)
  100. {
  101.     while (*str)
  102.         putc_function(*(str++));
  103. }
  104.  
  105. void serial_goto(const unsigned int row, const unsigned int col)
  106. {
  107.     if ((row > scr_height) || (col > scr_width))
  108.         return;
  109.    
  110.     char control[MAX_CONTROL];
  111.     snprintf(control, MAX_CONTROL, "\033[%u;%uf", row + 1, col + 1);
  112.     serial_puts(control);
  113. }
  114.  
  115. void serial_clrscr(void)
  116. {
  117.     /* Initialize graphic rendition attributes. */
  118.     serial_sgr(SGR_RESET);
  119.     if (color) {
  120.         serial_sgr(SGR_FGCOLOR + CI_BLACK);
  121.         serial_sgr(SGR_BGCOLOR + CI_WHITE);
  122.     }
  123.  
  124.     serial_puts("\033[2J");
  125. }
  126.  
  127. void serial_scroll(int i)
  128. {
  129.     if (i > 0) {
  130.         serial_goto(scr_height - 1, 0);
  131.         while (i--)
  132.             serial_puts("\033D");
  133.     } else if (i < 0) {
  134.         serial_goto(0, 0);
  135.         while (i++)
  136.             serial_puts("\033M");
  137.     }
  138. }
  139.  
  140. /** ECMA-48 Set Graphics Rendition. */
  141. static void serial_sgr(const unsigned int mode)
  142. {
  143.     char control[MAX_CONTROL];
  144.     snprintf(control, MAX_CONTROL, "\033[%um", mode);
  145.     serial_puts(control);
  146. }
  147.  
  148. /** Set scrolling region. */
  149. void serial_set_scroll_region(unsigned last_row)
  150. {
  151.     char control[MAX_CONTROL];
  152.     snprintf(control, MAX_CONTROL, "\033[0;%ur", last_row);
  153.     serial_puts(control);
  154. }
  155.  
  156. void serial_cursor_disable(void)
  157. {
  158.     serial_puts("\033[?25l");
  159. }
  160.  
  161. void serial_cursor_enable(void)
  162. {
  163.     serial_puts("\033[?25h");
  164. }
  165.  
  166. void serial_console_init(putc_function_t putc_fn, uint32_t w, uint32_t h)
  167. {
  168.     scr_width = w;
  169.     scr_height = h;
  170.     putc_function = putc_fn;
  171. }
  172.  
  173. static void serial_set_style(int style)
  174. {
  175.     if (style == STYLE_EMPHASIS) {
  176.         if (color) {
  177.             serial_sgr(SGR_RESET);
  178.             serial_sgr(SGR_FGCOLOR + CI_RED);
  179.             serial_sgr(SGR_BGCOLOR + CI_WHITE);
  180.         }
  181.         serial_sgr(SGR_BOLD);
  182.     } else {
  183.         if (color) {
  184.             serial_sgr(SGR_RESET);
  185.             serial_sgr(SGR_FGCOLOR + CI_BLACK);
  186.             serial_sgr(SGR_BGCOLOR + CI_WHITE);
  187.         }
  188.         serial_sgr(SGR_NORMAL_INT);
  189.     }
  190. }
  191.  
  192. static void serial_set_idx(unsigned fgcolor, unsigned bgcolor,
  193.     unsigned flags)
  194. {
  195.     if (color) {
  196.         serial_sgr(SGR_RESET);
  197.         serial_sgr(SGR_FGCOLOR + color_map[fgcolor]);
  198.         serial_sgr(SGR_BGCOLOR + color_map[bgcolor]);
  199.     } else {
  200.         if (fgcolor < bgcolor)
  201.             serial_sgr(SGR_RESET);
  202.         else
  203.             serial_sgr(SGR_REVERSE);
  204.     }  
  205. }
  206.  
  207. static void serial_set_rgb(uint32_t fgcolor, uint32_t bgcolor)
  208. {
  209.     if (fgcolor < bgcolor)
  210.         serial_sgr(SGR_REVERSE_OFF);
  211.     else
  212.         serial_sgr(SGR_REVERSE);   
  213. }
  214.  
  215. static void serial_set_attrs(const attrs_t *a)
  216. {
  217.     switch (a->t) {
  218.     case at_style: serial_set_style(a->a.s.style); break;
  219.     case at_rgb: serial_set_rgb(a->a.r.fg_color, a->a.r.bg_color); break;
  220.     case at_idx: serial_set_idx(a->a.i.fg_color,
  221.         a->a.i.bg_color, a->a.i.flags); break;
  222.     default: break;
  223.     }
  224. }
  225.  
  226. static void draw_text_data(keyfield_t *data)
  227. {
  228.     int i, j;
  229.     attrs_t *a0, *a1;
  230.  
  231.     serial_goto(0, 0);
  232.     a0 = &data[0].attrs;
  233.     serial_set_attrs(a0);
  234.  
  235.     for (i = 0; i < scr_height; i++) {
  236.         for (j = 0; j < scr_width; j++) {
  237.             a1 = &data[i * scr_width + j].attrs;
  238.             if (!attrs_same(*a0, *a1))
  239.                 serial_set_attrs(a1);
  240.             (*putc_function)(data[i * scr_width + j].character);
  241.             a0 = a1;
  242.         }
  243.     }
  244. }
  245.  
  246. int lastcol = 0;
  247. int lastrow = 0;
  248.  
  249. #define FB_WRITE_BUF_SIZE 256
  250. static char fb_write_buf[FB_WRITE_BUF_SIZE];
  251.  
  252. static void fb_write(ipc_callid_t rid, ipc_call_t *request)
  253. {
  254.     int row, col;
  255.     ipc_callid_t callid;
  256.     size_t len;
  257.     size_t i;
  258.  
  259.     row = IPC_GET_ARG1(*request);
  260.     col = IPC_GET_ARG2(*request);
  261.  
  262.     if ((col >= scr_width) || (row >= scr_height)) {
  263.         ipc_answer_0(callid, EINVAL);
  264.         ipc_answer_0(rid, EINVAL);
  265.         return;
  266.     }
  267.  
  268.     if (!ipc_data_write_receive(&callid, &len)) {
  269.         ipc_answer_0(callid, EINVAL);
  270.         ipc_answer_0(rid, EINVAL);
  271.         return;
  272.     }
  273.  
  274.     if (len > FB_WRITE_BUF_SIZE)
  275.         len = FB_WRITE_BUF_SIZE;
  276.     if (len >= scr_width - col)
  277.         len = scr_width - col;
  278.  
  279.     (void) ipc_data_write_finalize(callid, fb_write_buf, len);
  280.  
  281.     if ((lastcol != col) || (lastrow != row))
  282.         serial_goto(row, col);
  283.  
  284.     for (i = 0; i < len; i++) {
  285.         (*putc_function)(fb_write_buf[i]);
  286.     }
  287.  
  288.     lastcol = col + len;
  289.     lastrow = row;
  290.  
  291.     ipc_answer_1(rid, EOK, len);
  292. }
  293.  
  294. /**
  295.  * Main function of the thread serving client connections.
  296.  */
  297. void serial_client_connection(ipc_callid_t iid, ipc_call_t *icall)
  298. {
  299.     int retval;
  300.     ipc_callid_t callid;
  301.     ipc_call_t call;
  302.     keyfield_t *interbuf = NULL;
  303.     size_t intersize = 0;
  304.  
  305.     char c;
  306.     int newcol;
  307.     int newrow;
  308.     int fgcolor;
  309.     int bgcolor;
  310.     int flags;
  311.     int style;
  312.     int i;
  313.  
  314.    
  315.     if (client_connected) {
  316.         ipc_answer_0(iid, ELIMIT);
  317.         return;
  318.     }
  319.    
  320.     client_connected = 1;
  321.     ipc_answer_0(iid, EOK);
  322.    
  323.     /* Clear the terminal, set scrolling region
  324.        to 0 - height rows. */
  325.     serial_clrscr();
  326.     serial_goto(0, 0);
  327.     serial_set_scroll_region(scr_height);
  328.    
  329.     while (true) {
  330.         callid = async_get_call(&call);
  331.         switch (IPC_GET_METHOD(call)) {
  332.         case IPC_M_PHONE_HUNGUP:
  333.             client_connected = 0;
  334.             ipc_answer_0(callid, EOK);
  335.             return;
  336.         case IPC_M_SHARE_OUT:
  337.             /* We accept one area for data interchange */
  338.             intersize = IPC_GET_ARG2(call);
  339.             if (intersize >= scr_width * scr_height *
  340.                 sizeof(*interbuf)) {
  341.                 receive_comm_area(callid, &call,
  342.                     (void *) &interbuf);
  343.                 continue;
  344.             }
  345.             retval = EINVAL;
  346.             break;
  347.         case FB_DRAW_TEXT_DATA:
  348.             if (!interbuf) {
  349.                 retval = EINVAL;
  350.                 break;
  351.             }
  352.             draw_text_data(interbuf);
  353.             retval = 0;
  354.             break;
  355.         case FB_PUTCHAR:
  356.             c = IPC_GET_ARG1(call);
  357.             newrow = IPC_GET_ARG2(call);
  358.             newcol = IPC_GET_ARG3(call);
  359.             if ((lastcol != newcol) || (lastrow != newrow))
  360.                 serial_goto(newrow, newcol);
  361.             lastcol = newcol + 1;
  362.             lastrow = newrow;
  363.             (*putc_function)(c);
  364.             retval = 0;
  365.             break;
  366.         case FB_WRITE:
  367.             fb_write(callid, &call);
  368.            
  369.             /* Message already answered */
  370.             continue;
  371.         case FB_CURSOR_GOTO:
  372.             newrow = IPC_GET_ARG1(call);
  373.             newcol = IPC_GET_ARG2(call);
  374.             serial_goto(newrow, newcol);
  375.             lastrow = newrow;
  376.             lastcol = newcol;
  377.             retval = 0;
  378.             break;
  379.         case FB_GET_CSIZE:
  380.             ipc_answer_2(callid, EOK, scr_height, scr_width);
  381.             continue;
  382.         case FB_CLEAR:
  383.             serial_clrscr();
  384.             retval = 0;
  385.             break;
  386.         case FB_SET_STYLE:
  387.             style = IPC_GET_ARG1(call);
  388.             serial_set_style(style);
  389.             retval = 0;
  390.             break;
  391.         case FB_SET_COLOR:
  392.             fgcolor = IPC_GET_ARG1(call);
  393.             bgcolor = IPC_GET_ARG2(call);
  394.             flags = IPC_GET_ARG3(call);
  395.  
  396.             serial_set_idx(fgcolor, bgcolor, flags);
  397.             retval = 0;
  398.             break;
  399.         case FB_SET_RGB_COLOR:
  400.             fgcolor = IPC_GET_ARG1(call);
  401.             bgcolor = IPC_GET_ARG2(call);
  402.  
  403.             serial_set_rgb(fgcolor, bgcolor);
  404.             retval = 0;
  405.             break;
  406.         case FB_SCROLL:
  407.             i = IPC_GET_ARG1(call);
  408.             if ((i > scr_height) || (i < -scr_height)) {
  409.                 retval = EINVAL;
  410.                 break;
  411.             }
  412.             serial_scroll(i);
  413.             serial_goto(lastrow, lastcol);
  414.             retval = 0;
  415.             break;
  416.         case FB_CURSOR_VISIBILITY:
  417.             if(IPC_GET_ARG1(call))
  418.                 serial_cursor_enable();
  419.             else
  420.                 serial_cursor_disable();
  421.             retval = 0;
  422.             break;
  423.         default:
  424.             retval = ENOENT;
  425.         }
  426.         ipc_answer_0(callid, retval);
  427.     }
  428. }
  429.  
  430. /**
  431.  * @}
  432.  */
  433.