Subversion Repositories HelenOS

Rev

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

  1. /*
  2.  * Copyright (C) 2001-2004 Jakub Jermar
  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 genarch   
  30.  * @{
  31.  */
  32. /** @file
  33.  */
  34.  
  35. #include <genarch/i8042/i8042.h>
  36. #include <arch/drivers/i8042.h>
  37. #include <arch/interrupt.h>
  38. #include <cpu.h>
  39. #include <arch/asm.h>
  40. #include <arch.h>
  41. #include <synch/spinlock.h>
  42. #include <typedefs.h>
  43. #include <console/chardev.h>
  44. #include <console/console.h>
  45. #include <macros.h>
  46. #include <interrupt.h>
  47.  
  48. /**
  49.  * i8042 processor driver.
  50.  * It takes care of low-level keyboard functions.
  51.  */
  52.  
  53. /** Keyboard commands. */
  54. #define KBD_ENABLE  0xf4
  55. #define KBD_DISABLE 0xf5
  56. #define KBD_ACK     0xfa
  57.  
  58. /*
  59.  * 60  Write 8042 Command Byte: next data byte written to port 60h is
  60.  *     placed in 8042 command register. Format:
  61.  *
  62.  *    |7|6|5|4|3|2|1|0|8042 Command Byte
  63.  *     | | | | | | | `---- 1=enable output register full interrupt
  64.  *     | | | | | | `----- should be 0
  65.  *     | | | | | `------ 1=set status register system, 0=clear
  66.  *     | | | | `------- 1=override keyboard inhibit, 0=allow inhibit
  67.  *     | | | `-------- disable keyboard I/O by driving clock line low
  68.  *     | | `--------- disable auxiliary device, drives clock line low
  69.  *     | `---------- IBM scancode translation 0=AT, 1=PC/XT
  70.  *     `----------- reserved, should be 0
  71.  */
  72.  
  73. #define i8042_SET_COMMAND   0x60
  74. #define i8042_COMMAND       0x49
  75.  
  76. #define i8042_BUFFER_FULL_MASK  0x01
  77. #define i8042_WAIT_MASK     0x02
  78.  
  79. #define SPECIAL     '?'
  80. #define KEY_RELEASE 0x80
  81.  
  82. /**
  83.  * These codes read from i8042 data register are silently ignored.
  84.  */
  85. #define IGNORE_CODE 0x7f
  86.  
  87. static void key_released(__u8 sc);
  88. static void key_pressed(__u8 sc);
  89. static char key_read(chardev_t *d);
  90.  
  91. #define PRESSED_SHIFT       (1<<0)
  92. #define PRESSED_CAPSLOCK    (1<<1)
  93. #define LOCKED_CAPSLOCK     (1<<0)
  94.  
  95. #define ACTIVE_READ_BUFF_SIZE 16    /* Must be power of 2 */
  96.  
  97. static __u8 active_read_buff[ACTIVE_READ_BUFF_SIZE];
  98.  
  99. SPINLOCK_INITIALIZE(keylock);       /**< keylock protects keyflags and lockflags. */
  100. static volatile int keyflags;       /**< Tracking of multiple keypresses. */
  101. static volatile int lockflags;      /**< Tracking of multiple keys lockings. */
  102.  
  103. static void i8042_suspend(chardev_t *);
  104. static void i8042_resume(chardev_t *);
  105.  
  106. static chardev_t kbrd;
  107. static chardev_operations_t ops = {
  108.     .suspend = i8042_suspend,
  109.     .resume = i8042_resume,
  110.     .read = key_read
  111. };
  112.  
  113. /** Primary meaning of scancodes. */
  114. static char sc_primary_map[] = {
  115.     SPECIAL, /* 0x00 */
  116.     SPECIAL, /* 0x01 - Esc */
  117.     '1', '2', '3', '4', '5', '6', '7', '8', '9', '0', '-', '=',
  118.     '\b', /* 0x0e - Backspace */
  119.     '\t', 'q', 'w', 'e', 'r', 't', 'y', 'u', 'i', 'o', 'p', '[', ']', '\n',
  120.     SPECIAL, /* 0x1d - LCtrl */
  121.     'a', 's', 'd', 'f', 'g', 'h', 'j', 'k', 'l', ';', '\'',
  122.     '`',
  123.     SPECIAL, /* 0x2a - LShift */
  124.     '\\',
  125.     'z', 'x', 'c', 'v', 'b', 'n', 'm', ',', '.', '/',
  126.     SPECIAL, /* 0x36 - RShift */
  127.     '*',
  128.     SPECIAL, /* 0x38 - LAlt */
  129.     ' ',
  130.     SPECIAL, /* 0x3a - CapsLock */
  131.     SPECIAL, /* 0x3b - F1 */
  132.     SPECIAL, /* 0x3c - F2 */
  133.     SPECIAL, /* 0x3d - F3 */
  134.     SPECIAL, /* 0x3e - F4 */
  135.     SPECIAL, /* 0x3f - F5 */
  136.     SPECIAL, /* 0x40 - F6 */
  137.     SPECIAL, /* 0x41 - F7 */
  138.     SPECIAL, /* 0x42 - F8 */
  139.     SPECIAL, /* 0x43 - F9 */
  140.     SPECIAL, /* 0x44 - F10 */
  141.     SPECIAL, /* 0x45 - NumLock */
  142.     SPECIAL, /* 0x46 - ScrollLock */
  143.     '7', '8', '9', '-',
  144.     '4', '5', '6', '+',
  145.     '1', '2', '3',
  146.     '0', '.',
  147.     SPECIAL, /* 0x54 - Alt-SysRq */
  148.     SPECIAL, /* 0x55 - F11/F12/PF1/FN */
  149.     SPECIAL, /* 0x56 - unlabelled key next to LAlt */
  150.     SPECIAL, /* 0x57 - F11 */
  151.     SPECIAL, /* 0x58 - F12 */
  152.     SPECIAL, /* 0x59 */
  153.     SPECIAL, /* 0x5a */
  154.     SPECIAL, /* 0x5b */
  155.     SPECIAL, /* 0x5c */
  156.     SPECIAL, /* 0x5d */
  157.     SPECIAL, /* 0x5e */
  158.     SPECIAL, /* 0x5f */
  159.     SPECIAL, /* 0x60 */
  160.     SPECIAL, /* 0x61 */
  161.     SPECIAL, /* 0x62 */
  162.     SPECIAL, /* 0x63 */
  163.     SPECIAL, /* 0x64 */
  164.     SPECIAL, /* 0x65 */
  165.     SPECIAL, /* 0x66 */
  166.     SPECIAL, /* 0x67 */
  167.     SPECIAL, /* 0x68 */
  168.     SPECIAL, /* 0x69 */
  169.     SPECIAL, /* 0x6a */
  170.     SPECIAL, /* 0x6b */
  171.     SPECIAL, /* 0x6c */
  172.     SPECIAL, /* 0x6d */
  173.     SPECIAL, /* 0x6e */
  174.     SPECIAL, /* 0x6f */
  175.     SPECIAL, /* 0x70 */
  176.     SPECIAL, /* 0x71 */
  177.     SPECIAL, /* 0x72 */
  178.     SPECIAL, /* 0x73 */
  179.     SPECIAL, /* 0x74 */
  180.     SPECIAL, /* 0x75 */
  181.     SPECIAL, /* 0x76 */
  182.     SPECIAL, /* 0x77 */
  183.     SPECIAL, /* 0x78 */
  184.     SPECIAL, /* 0x79 */
  185.     SPECIAL, /* 0x7a */
  186.     SPECIAL, /* 0x7b */
  187.     SPECIAL, /* 0x7c */
  188.     SPECIAL, /* 0x7d */
  189.     SPECIAL, /* 0x7e */
  190.     SPECIAL, /* 0x7f */
  191. };
  192.  
  193. /** Secondary meaning of scancodes. */
  194. static char sc_secondary_map[] = {
  195.     SPECIAL, /* 0x00 */
  196.     SPECIAL, /* 0x01 - Esc */
  197.     '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', '_', '+',
  198.     SPECIAL, /* 0x0e - Backspace */
  199.     '\t', 'Q', 'W', 'E', 'R', 'T', 'Y', 'U', 'I', 'O', 'P', '{', '}', '\n',
  200.     SPECIAL, /* 0x1d - LCtrl */
  201.     'A', 'S', 'D', 'F', 'G', 'H', 'J', 'K', 'L', ':', '"',
  202.     '~',
  203.     SPECIAL, /* 0x2a - LShift */
  204.     '|',
  205.     'Z', 'X', 'C', 'V', 'B', 'N', 'M', '<', '>', '?',
  206.     SPECIAL, /* 0x36 - RShift */
  207.     '*',
  208.     SPECIAL, /* 0x38 - LAlt */
  209.     ' ',
  210.     SPECIAL, /* 0x3a - CapsLock */
  211.     SPECIAL, /* 0x3b - F1 */
  212.     SPECIAL, /* 0x3c - F2 */
  213.     SPECIAL, /* 0x3d - F3 */
  214.     SPECIAL, /* 0x3e - F4 */
  215.     SPECIAL, /* 0x3f - F5 */
  216.     SPECIAL, /* 0x40 - F6 */
  217.     SPECIAL, /* 0x41 - F7 */
  218.     SPECIAL, /* 0x42 - F8 */
  219.     SPECIAL, /* 0x43 - F9 */
  220.     SPECIAL, /* 0x44 - F10 */
  221.     SPECIAL, /* 0x45 - NumLock */
  222.     SPECIAL, /* 0x46 - ScrollLock */
  223.     '7', '8', '9', '-',
  224.     '4', '5', '6', '+',
  225.     '1', '2', '3',
  226.     '0', '.',
  227.     SPECIAL, /* 0x54 - Alt-SysRq */
  228.     SPECIAL, /* 0x55 - F11/F12/PF1/FN */
  229.     SPECIAL, /* 0x56 - unlabelled key next to LAlt */
  230.     SPECIAL, /* 0x57 - F11 */
  231.     SPECIAL, /* 0x58 - F12 */
  232.     SPECIAL, /* 0x59 */
  233.     SPECIAL, /* 0x5a */
  234.     SPECIAL, /* 0x5b */
  235.     SPECIAL, /* 0x5c */
  236.     SPECIAL, /* 0x5d */
  237.     SPECIAL, /* 0x5e */
  238.     SPECIAL, /* 0x5f */
  239.     SPECIAL, /* 0x60 */
  240.     SPECIAL, /* 0x61 */
  241.     SPECIAL, /* 0x62 */
  242.     SPECIAL, /* 0x63 */
  243.     SPECIAL, /* 0x64 */
  244.     SPECIAL, /* 0x65 */
  245.     SPECIAL, /* 0x66 */
  246.     SPECIAL, /* 0x67 */
  247.     SPECIAL, /* 0x68 */
  248.     SPECIAL, /* 0x69 */
  249.     SPECIAL, /* 0x6a */
  250.     SPECIAL, /* 0x6b */
  251.     SPECIAL, /* 0x6c */
  252.     SPECIAL, /* 0x6d */
  253.     SPECIAL, /* 0x6e */
  254.     SPECIAL, /* 0x6f */
  255.     SPECIAL, /* 0x70 */
  256.     SPECIAL, /* 0x71 */
  257.     SPECIAL, /* 0x72 */
  258.     SPECIAL, /* 0x73 */
  259.     SPECIAL, /* 0x74 */
  260.     SPECIAL, /* 0x75 */
  261.     SPECIAL, /* 0x76 */
  262.     SPECIAL, /* 0x77 */
  263.     SPECIAL, /* 0x78 */
  264.     SPECIAL, /* 0x79 */
  265.     SPECIAL, /* 0x7a */
  266.     SPECIAL, /* 0x7b */
  267.     SPECIAL, /* 0x7c */
  268.     SPECIAL, /* 0x7d */
  269.     SPECIAL, /* 0x7e */
  270.     SPECIAL, /* 0x7f */
  271. };
  272.  
  273. static void i8042_interrupt(int n, istate_t *istate);
  274. static void i8042_wait(void);
  275.  
  276. static iroutine oldvector;
  277. /** Initialize keyboard and service interrupts using kernel routine */
  278. void i8042_grab(void)
  279. {
  280.     oldvector = exc_register(VECTOR_KBD, "i8042_interrupt", (iroutine) i8042_interrupt);
  281.     i8042_wait();
  282.     i8042_command_write(i8042_SET_COMMAND);
  283.     i8042_wait();
  284.     i8042_data_write(i8042_COMMAND);
  285.     i8042_wait();
  286. }
  287. /** Resume the former interrupt vector */
  288. void i8042_release(void)
  289. {
  290.     if (oldvector)
  291.         exc_register(VECTOR_KBD, "user_interrupt", oldvector);
  292. }
  293.  
  294. /** Initialize i8042. */
  295. void i8042_init(void)
  296. {
  297.     int i;
  298.  
  299.     i8042_grab();
  300.         /* Prevent user from accidentaly releasing calling i8042_resume
  301.      * and disabling keyboard
  302.      */
  303.     oldvector = NULL;
  304.  
  305.     trap_virtual_enable_irqs(1<<IRQ_KBD);
  306.     chardev_initialize("i8042_kbd", &kbrd, &ops);
  307.     stdin = &kbrd;
  308.  
  309.     /*
  310.      * Clear input buffer.
  311.      * Number of iterations is limited to prevent infinite looping.
  312.      */
  313.     for (i = 0; (i8042_status_read() & i8042_BUFFER_FULL_MASK) && i < 100; i++) {
  314.         i8042_data_read();
  315.     }  
  316. }
  317.  
  318. /** Process i8042 interrupt.
  319.  *
  320.  * @param n Interrupt vector.
  321.  * @param istate Interrupted state.
  322.  */
  323. void i8042_interrupt(int n, istate_t *istate)
  324. {
  325.     __u8 x;
  326.  
  327.     while ((i8042_status_read() & i8042_BUFFER_FULL_MASK)) {
  328.         x = i8042_data_read();
  329.         if (x & KEY_RELEASE)
  330.             key_released(x ^ KEY_RELEASE);
  331.         else
  332.             key_pressed(x);
  333.     }
  334.     trap_virtual_eoi();
  335. }
  336.  
  337. /** Wait until the controller reads its data. */
  338. void i8042_wait(void) {
  339.     while (i8042_status_read() & i8042_WAIT_MASK) {
  340.         /* wait */
  341.     }
  342. }
  343.  
  344. /** Process release of key.
  345.  *
  346.  * @param sc Scancode of the key being released.
  347.  */
  348. void key_released(__u8 sc)
  349. {
  350.     spinlock_lock(&keylock);
  351.     switch (sc) {
  352.         case SC_LSHIFT:
  353.         case SC_RSHIFT:
  354.         keyflags &= ~PRESSED_SHIFT;
  355.         break;
  356.         case SC_CAPSLOCK:
  357.         keyflags &= ~PRESSED_CAPSLOCK;
  358.         if (lockflags & LOCKED_CAPSLOCK)
  359.             lockflags &= ~LOCKED_CAPSLOCK;
  360.         else
  361.             lockflags |= LOCKED_CAPSLOCK;
  362.         break;
  363.         default:
  364.         break;
  365.     }
  366.     spinlock_unlock(&keylock);
  367. }
  368.  
  369. /** Process keypress.
  370.  *
  371.  * @param sc Scancode of the key being pressed.
  372.  */
  373. void key_pressed(__u8 sc)
  374. {
  375.     char *map = sc_primary_map;
  376.     char ascii = sc_primary_map[sc];
  377.     bool shift, capslock;
  378.     bool letter = false;
  379.  
  380.     spinlock_lock(&keylock);
  381.     switch (sc) {
  382.     case SC_LSHIFT:
  383.     case SC_RSHIFT:
  384.             keyflags |= PRESSED_SHIFT;
  385.         break;
  386.     case SC_CAPSLOCK:
  387.         keyflags |= PRESSED_CAPSLOCK;
  388.         break;
  389.     case SC_SPEC_ESCAPE:
  390.         break;
  391.     case SC_LEFTARR:
  392.         chardev_push_character(&kbrd, 0x1b);
  393.         chardev_push_character(&kbrd, 0x5b);
  394.         chardev_push_character(&kbrd, 0x44);
  395.         break;
  396.     case SC_RIGHTARR:
  397.         chardev_push_character(&kbrd, 0x1b);
  398.         chardev_push_character(&kbrd, 0x5b);
  399.         chardev_push_character(&kbrd, 0x43);
  400.         break;
  401.     case SC_UPARR:
  402.         chardev_push_character(&kbrd, 0x1b);
  403.         chardev_push_character(&kbrd, 0x5b);
  404.         chardev_push_character(&kbrd, 0x41);
  405.         break;
  406.     case SC_DOWNARR:
  407.         chardev_push_character(&kbrd, 0x1b);
  408.         chardev_push_character(&kbrd, 0x5b);
  409.         chardev_push_character(&kbrd, 0x42);
  410.         break;
  411.     case SC_HOME:
  412.         chardev_push_character(&kbrd, 0x1b);
  413.         chardev_push_character(&kbrd, 0x4f);
  414.         chardev_push_character(&kbrd, 0x48);
  415.         break;
  416.     case SC_END:
  417.         chardev_push_character(&kbrd, 0x1b);
  418.         chardev_push_character(&kbrd, 0x4f);
  419.         chardev_push_character(&kbrd, 0x46);
  420.         break;
  421.     case SC_DELETE:
  422.         chardev_push_character(&kbrd, 0x1b);
  423.         chardev_push_character(&kbrd, 0x5b);
  424.         chardev_push_character(&kbrd, 0x33);
  425.         chardev_push_character(&kbrd, 0x7e);
  426.         break;
  427.     default:
  428.             letter = is_lower(ascii);
  429.         capslock = (keyflags & PRESSED_CAPSLOCK) || (lockflags & LOCKED_CAPSLOCK);
  430.         shift = keyflags & PRESSED_SHIFT;
  431.         if (letter && capslock)
  432.             shift = !shift;
  433.         if (shift)
  434.             map = sc_secondary_map;
  435.         chardev_push_character(&kbrd, map[sc]);
  436.         break;
  437.     }
  438.     spinlock_unlock(&keylock);
  439. }
  440.  
  441. /* Called from getc(). */
  442. void i8042_resume(chardev_t *d)
  443. {
  444. }
  445.  
  446. /* Called from getc(). */
  447. void i8042_suspend(chardev_t *d)
  448. {
  449. }
  450.  
  451. static __u8 active_read_buff_read(void)
  452. {
  453.     static int i=0;
  454.     i &= (ACTIVE_READ_BUFF_SIZE-1);
  455.     if(!active_read_buff[i]) {
  456.         return 0;
  457.     }
  458.     return active_read_buff[i++];
  459. }
  460.  
  461. static void active_read_buff_write(__u8 ch)
  462. {
  463.     static int i=0;
  464.     active_read_buff[i] = ch;
  465.     i++;
  466.     i &= (ACTIVE_READ_BUFF_SIZE-1);
  467.     active_read_buff[i]=0;
  468. }
  469.  
  470.  
  471. static void active_read_key_pressed(__u8 sc)
  472. {
  473.     char *map = sc_primary_map;
  474.     char ascii = sc_primary_map[sc];
  475.     bool shift, capslock;
  476.     bool letter = false;
  477.  
  478.     /*spinlock_lock(&keylock);*/
  479.     switch (sc) {
  480.     case SC_LSHIFT:
  481.     case SC_RSHIFT:
  482.             keyflags |= PRESSED_SHIFT;
  483.         break;
  484.     case SC_CAPSLOCK:
  485.         keyflags |= PRESSED_CAPSLOCK;
  486.         break;
  487.     case SC_SPEC_ESCAPE:
  488.         break;
  489.     case SC_LEFTARR:
  490.         active_read_buff_write(0x1b);
  491.         active_read_buff_write(0x5b);
  492.         active_read_buff_write(0x44);
  493.         break;
  494.     case SC_RIGHTARR:
  495.         active_read_buff_write(0x1b);
  496.         active_read_buff_write(0x5b);
  497.         active_read_buff_write(0x43);
  498.         break;
  499.     case SC_UPARR:
  500.         active_read_buff_write(0x1b);
  501.         active_read_buff_write(0x5b);
  502.         active_read_buff_write(0x41);
  503.         break;
  504.     case SC_DOWNARR:
  505.         active_read_buff_write(0x1b);
  506.         active_read_buff_write(0x5b);
  507.         active_read_buff_write(0x42);
  508.         break;
  509.     case SC_HOME:
  510.         active_read_buff_write(0x1b);
  511.         active_read_buff_write(0x4f);
  512.         active_read_buff_write(0x48);
  513.         break;
  514.     case SC_END:
  515.         active_read_buff_write(0x1b);
  516.         active_read_buff_write(0x4f);
  517.         active_read_buff_write(0x46);
  518.         break;
  519.     case SC_DELETE:
  520.         active_read_buff_write(0x1b);
  521.         active_read_buff_write(0x5b);
  522.         active_read_buff_write(0x33);
  523.         active_read_buff_write(0x7e);
  524.         break;
  525.     default:
  526.             letter = is_lower(ascii);
  527.         capslock = (keyflags & PRESSED_CAPSLOCK) || (lockflags & LOCKED_CAPSLOCK);
  528.         shift = keyflags & PRESSED_SHIFT;
  529.         if (letter && capslock)
  530.             shift = !shift;
  531.         if (shift)
  532.             map = sc_secondary_map;
  533.         active_read_buff_write(map[sc]);
  534.         break;
  535.     }
  536.     /*spinlock_unlock(&keylock);*/
  537.  
  538. }
  539.  
  540. static char key_read(chardev_t *d)
  541. {
  542.     char ch;   
  543.  
  544.     while(!(ch = active_read_buff_read())) {
  545.         __u8 x;
  546.         while (!(i8042_status_read() & i8042_BUFFER_FULL_MASK))
  547.             ;
  548.         x = i8042_data_read();
  549.         if (x != IGNORE_CODE) {
  550.             if (x & KEY_RELEASE)
  551.                 key_released(x ^ KEY_RELEASE);
  552.             else
  553.                 active_read_key_pressed(x);
  554.         }
  555.     }
  556.     return ch;
  557. }
  558.  
  559. /** Poll for key press and release events.
  560.  *
  561.  * This function can be used to implement keyboard polling.
  562.  */
  563. void i8042_poll(void)
  564. {
  565.     __u8 x;
  566.  
  567.     while (((x = i8042_status_read() & i8042_BUFFER_FULL_MASK))) {
  568.         x = i8042_data_read();
  569.         if (x != IGNORE_CODE) {
  570.             if (x & KEY_RELEASE)
  571.                 key_released(x ^ KEY_RELEASE);
  572.             else
  573.                 key_pressed(x);
  574.         }
  575.     }
  576. }
  577.  
  578.  /** @}
  579.  */
  580.  
  581.