Ignore:
File:
1 edited

Legend:

Unmodified
Added
Removed
  • uspace/drv/char/i8042/i8042.c

    rcccdb8b7 r876f6463  
    2929 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    3030 */
     31
    3132/** @addtogroup kbd_port
    3233 * @ingroup kbd
    3334 * @{
    3435 */
     36
    3537/** @file
    3638 * @brief i8042 PS/2 port driver.
     
    4446#include <str_error.h>
    4547#include <inttypes.h>
    46 
    4748#include <ddf/log.h>
    4849#include <ddf/interrupt.h>
    49 
    5050#include "i8042.h"
    5151
    52 #define NAME       "i8042"
     52/* Interesting bits for status register */
     53#define i8042_OUTPUT_FULL  0x01
     54#define i8042_INPUT_FULL   0x02
     55#define i8042_AUX_DATA     0x20
     56
     57/* Command constants */
     58#define i8042_CMD_WRITE_CMDB  0x60  /**< Write command byte */
     59#define i8042_CMD_WRITE_AUX   0xd4  /**< Write aux device */
     60
     61/* Command byte fields */
     62#define i8042_KBD_IE         0x01
     63#define i8042_AUX_IE         0x02
     64#define i8042_KBD_DISABLE    0x10
     65#define i8042_AUX_DISABLE    0x20
     66#define i8042_KBD_TRANSLATE  0x40  /* Use this to switch to XT scancodes */
     67
     68#define CHECK_RET_DESTROY(ret, msg...) \
     69        do { \
     70                if (ret != EOK) { \
     71                        ddf_msg(LVL_ERROR, msg); \
     72                        if (dev->kbd_fun) { \
     73                                dev->kbd_fun->driver_data = NULL; \
     74                                ddf_fun_destroy(dev->kbd_fun); \
     75                        } \
     76                        if (dev->aux_fun) { \
     77                                dev->aux_fun->driver_data = NULL; \
     78                                ddf_fun_destroy(dev->aux_fun); \
     79                        } \
     80                } \
     81        } while (0)
     82
     83#define CHECK_RET_UNBIND_DESTROY(ret, msg...) \
     84        do { \
     85                if (ret != EOK) { \
     86                        ddf_msg(LVL_ERROR, msg); \
     87                        if (dev->kbd_fun) { \
     88                                ddf_fun_unbind(dev->kbd_fun); \
     89                                dev->kbd_fun->driver_data = NULL; \
     90                                ddf_fun_destroy(dev->kbd_fun); \
     91                        } \
     92                        if (dev->aux_fun) { \
     93                                ddf_fun_unbind(dev->aux_fun); \
     94                                dev->aux_fun->driver_data = NULL; \
     95                                ddf_fun_destroy(dev->aux_fun); \
     96                        } \
     97                } \
     98        } while (0)
    5399
    54100void default_handler(ddf_fun_t *, ipc_callid_t, ipc_call_t *);
     
    59105};
    60106
    61 /* Interesting bits for status register */
    62 #define i8042_OUTPUT_FULL       0x01
    63 #define i8042_INPUT_FULL        0x02
    64 #define i8042_AUX_DATA          0x20
    65 
    66 /* Command constants */
    67 #define i8042_CMD_WRITE_CMDB    0x60    /**< write command byte */
    68 #define i8042_CMD_WRITE_AUX     0xd4    /**< write aux device */
    69 
    70 /* Command byte fields */
    71 #define i8042_KBD_IE            0x01
    72 #define i8042_AUX_IE            0x02
    73 #define i8042_KBD_DISABLE       0x10
    74 #define i8042_AUX_DISABLE       0x20
    75 #define i8042_KBD_TRANSLATE     0x40 /* Use this to switch to XT scancodes */
    76 
    77 static const irq_pio_range_t i8042_ranges[] = {
    78         {
    79                 .base = 0,
    80                 .size = sizeof(i8042_regs_t)
    81         }
    82 };
    83 
    84107/** i8042 Interrupt pseudo-code. */
    85108static const irq_cmd_t i8042_cmds[] = {
    86109        {
    87110                .cmd = CMD_PIO_READ_8,
    88                 .addr = NULL,   /* will be patched in run-time */
     111                .addr = NULL,  /* will be patched in run-time */
    89112                .dstarg = 1
    90113        },
     
    102125        {
    103126                .cmd = CMD_PIO_READ_8,
    104                 .addr = NULL,   /* will be patched in run-time */
     127                .addr = NULL,  /* will be patched in run-time */
    105128                .dstarg = 2
    106129        },
     
    118141
    119142/** Interrupt handler routine.
    120  * Writes new data to the corresponding buffer.
    121  * @param dev Device that caued the interrupt.
    122  * @param iid Call id.
     143 *
     144 * Write new data to the corresponding buffer.
     145 *
     146 * @param dev  Device that caued the interrupt.
     147 * @param iid  Call id.
    123148 * @param call pointerr to call data.
    124  */
    125 static void i8042_irq_handler(
    126     ddf_dev_t *dev, ipc_callid_t iid, ipc_call_t *call)
    127 {
    128         if (!dev || !dev->driver_data)
     149 *
     150 */
     151static void i8042_irq_handler(ddf_dev_t *dev, ipc_callid_t iid,
     152    ipc_call_t *call)
     153{
     154        if ((!dev) || (!dev->driver_data))
    129155                return;
     156       
    130157        i8042_t *controller = dev->driver_data;
    131 
     158       
    132159        const uint8_t status = IPC_GET_ARG1(*call);
    133160        const uint8_t data = IPC_GET_ARG2(*call);
     161       
    134162        buffer_t *buffer = (status & i8042_AUX_DATA) ?
    135163            &controller->aux_buffer : &controller->kbd_buffer;
     164       
    136165        buffer_write(buffer, data);
    137166}
    138167
    139168/** Initialize i8042 driver structure.
    140  * @param dev Driver structure to initialize.
    141  * @param regs I/O address of registers.
    142  * @param reg_size size of the reserved I/O address space.
    143  * @param irq_kbd IRQ for primary port.
     169 *
     170 * @param dev       Driver structure to initialize.
     171 * @param regs      I/O address of registers.
     172 * @param reg_size  size of the reserved I/O address space.
     173 * @param irq_kbd   IRQ for primary port.
    144174 * @param irq_mouse IRQ for aux port.
    145  * @param ddf_dev DDF device structure of the device.
     175 * @param ddf_dev   DDF device structure of the device.
     176 *
    146177 * @return Error code.
     178 *
    147179 */
    148180int i8042_init(i8042_t *dev, void *regs, size_t reg_size, int irq_kbd,
     
    151183        assert(ddf_dev);
    152184        assert(dev);
    153 
     185       
    154186        if (reg_size < sizeof(i8042_regs_t))
    155187                return EINVAL;
    156 
    157         if (pio_enable(regs, sizeof(i8042_regs_t), (void**)&dev->regs) != 0)
     188       
     189        if (pio_enable(regs, sizeof(i8042_regs_t), (void **) &dev->regs) != 0)
    158190                return -1;
    159 
     191       
    160192        dev->kbd_fun = ddf_fun_create(ddf_dev, fun_inner, "ps2a");
    161193        if (!dev->kbd_fun)
    162194                return ENOMEM;
     195       
    163196        int ret = ddf_fun_add_match_id(dev->kbd_fun, "char/xtkbd", 90);
    164197        if (ret != EOK) {
     
    166199                return ret;
    167200        }
    168 
     201       
    169202        dev->aux_fun = ddf_fun_create(ddf_dev, fun_inner, "ps2b");
    170203        if (!dev->aux_fun) {
     
    172205                return ENOMEM;
    173206        }
    174 
     207       
    175208        ret = ddf_fun_add_match_id(dev->aux_fun, "char/ps2mouse", 90);
    176209        if (ret != EOK) {
     
    179212                return ret;
    180213        }
    181 
     214       
    182215        dev->kbd_fun->ops = &ops;
    183216        dev->aux_fun->ops = &ops;
    184217        dev->kbd_fun->driver_data = dev;
    185218        dev->aux_fun->driver_data = dev;
    186 
     219       
    187220        buffer_init(&dev->kbd_buffer, dev->kbd_data, BUFFER_SIZE);
    188221        buffer_init(&dev->aux_buffer, dev->aux_data, BUFFER_SIZE);
    189222        fibril_mutex_initialize(&dev->write_guard);
    190 
    191 #define CHECK_RET_DESTROY(ret, msg...) \
    192 if  (ret != EOK) { \
    193         ddf_msg(LVL_ERROR, msg); \
    194         if (dev->kbd_fun) { \
    195                 dev->kbd_fun->driver_data = NULL; \
    196                 ddf_fun_destroy(dev->kbd_fun); \
    197         } \
    198         if (dev->aux_fun) { \
    199                 dev->aux_fun->driver_data = NULL; \
    200                 ddf_fun_destroy(dev->aux_fun); \
    201         } \
    202 } else (void)0
    203 
     223       
    204224        ret = ddf_fun_bind(dev->kbd_fun);
    205         CHECK_RET_DESTROY(ret,
    206             "Failed to bind keyboard function: %s.", str_error(ret));
    207 
     225        CHECK_RET_DESTROY(ret, "Failed to bind keyboard function: %s.",
     226            str_error(ret));
     227       
    208228        ret = ddf_fun_bind(dev->aux_fun);
    209         CHECK_RET_DESTROY(ret,
    210             "Failed to bind mouse function: %s.", str_error(ret));
    211 
     229        CHECK_RET_DESTROY(ret, "Failed to bind mouse function: %s.",
     230            str_error(ret));
     231       
    212232        /* Disable kbd and aux */
    213233        wait_ready(dev);
     
    215235        wait_ready(dev);
    216236        pio_write_8(&dev->regs->data, i8042_KBD_DISABLE | i8042_AUX_DISABLE);
    217 
     237       
    218238        /* Flush all current IO */
    219239        while (pio_read_8(&dev->regs->status) & i8042_OUTPUT_FULL)
    220240                (void) pio_read_8(&dev->regs->data);
    221 
    222 #define CHECK_RET_UNBIND_DESTROY(ret, msg...) \
    223 if  (ret != EOK) { \
    224         ddf_msg(LVL_ERROR, msg); \
    225         if (dev->kbd_fun) { \
    226                 ddf_fun_unbind(dev->kbd_fun); \
    227                 dev->kbd_fun->driver_data = NULL; \
    228                 ddf_fun_destroy(dev->kbd_fun); \
    229         } \
    230         if (dev->aux_fun) { \
    231                 ddf_fun_unbind(dev->aux_fun); \
    232                 dev->aux_fun->driver_data = NULL; \
    233                 ddf_fun_destroy(dev->aux_fun); \
    234         } \
    235 } else (void)0
    236 
    237         const size_t range_count = sizeof(i8042_ranges) /
    238             sizeof(irq_pio_range_t);
    239         irq_pio_range_t ranges[range_count];
    240         memcpy(ranges, i8042_ranges, sizeof(i8042_ranges));
    241         ranges[0].base = (uintptr_t) regs;
    242 
     241       
    243242        const size_t cmd_count = sizeof(i8042_cmds) / sizeof(irq_cmd_t);
    244243        irq_cmd_t cmds[cmd_count];
    245244        memcpy(cmds, i8042_cmds, sizeof(i8042_cmds));
    246         cmds[0].addr = (void *) &(((i8042_regs_t *) regs)->status);
    247         cmds[3].addr = (void *) &(((i8042_regs_t *) regs)->data);
    248 
     245        cmds[0].addr = (void *) &dev->regs->status;
     246        cmds[3].addr = (void *) &dev->regs->data;
     247       
    249248        irq_code_t irq_code = {
    250                 .rangecount = range_count,
    251                 .ranges = ranges,
    252249                .cmdcount = cmd_count,
    253250                .cmds = cmds
    254251        };
     252       
    255253        ret = register_interrupt_handler(ddf_dev, irq_kbd, i8042_irq_handler,
    256254            &irq_code);
    257         CHECK_RET_UNBIND_DESTROY(ret,
    258             "Failed set handler for kbd: %s.", str_error(ret));
    259 
     255        CHECK_RET_UNBIND_DESTROY(ret, "Failed set handler for kbd: %s.",
     256            str_error(ret));
     257       
    260258        ret = register_interrupt_handler(ddf_dev, irq_mouse, i8042_irq_handler,
    261259            &irq_code);
    262         CHECK_RET_UNBIND_DESTROY(ret,
    263             "Failed set handler for mouse: %s.", str_error(ret));
    264 
     260        CHECK_RET_UNBIND_DESTROY(ret, "Failed set handler for mouse: %s.",
     261            str_error(ret));
     262       
    265263        /* Enable interrupts */
    266264        async_sess_t *parent_sess =
     
    269267        ret = parent_sess ? EOK : ENOMEM;
    270268        CHECK_RET_UNBIND_DESTROY(ret, "Failed to create parent connection.");
    271 
     269       
    272270        const bool enabled = hw_res_enable_interrupt(parent_sess);
    273271        async_hangup(parent_sess);
    274272        ret = enabled ? EOK : EIO;
    275273        CHECK_RET_UNBIND_DESTROY(ret, "Failed to enable interrupts: %s.");
    276 
     274       
    277275        /* Enable port interrupts. */
    278276        wait_ready(dev);
     
    281279        pio_write_8(&dev->regs->data, i8042_KBD_IE | i8042_KBD_TRANSLATE |
    282280            i8042_AUX_IE);
    283 
     281       
    284282        return EOK;
    285283}
    286284
    287 // TODO use shared instead this
     285// FIXME TODO use shared instead this
    288286enum {
    289287        IPC_CHAR_READ = DEV_FIRST_CUSTOM_METHOD,
     
    292290
    293291/** Write data to i8042 port.
    294  * @param fun DDF function.
     292 *
     293 * @param fun    DDF function.
    295294 * @param buffer Data source.
    296  * @param size Data size.
     295 * @param size   Data size.
     296 *
    297297 * @return Bytes written.
     298 *
    298299 */
    299300static int i8042_write(ddf_fun_t *fun, char *buffer, size_t size)
     
    301302        assert(fun);
    302303        assert(fun->driver_data);
     304       
    303305        i8042_t *controller = fun->driver_data;
    304306        fibril_mutex_lock(&controller->write_guard);
     307       
    305308        for (size_t i = 0; i < size; ++i) {
     309                if (controller->aux_fun == fun) {
     310                        wait_ready(controller);
     311                        pio_write_8(&controller->regs->status,
     312                            i8042_CMD_WRITE_AUX);
     313                }
     314               
    306315                wait_ready(controller);
    307                 if (controller->aux_fun == fun)
    308                         pio_write_8(
    309                             &controller->regs->status, i8042_CMD_WRITE_AUX);
    310316                pio_write_8(&controller->regs->data, buffer[i]);
    311317        }
     318       
    312319        fibril_mutex_unlock(&controller->write_guard);
    313320        return size;
     
    315322
    316323/** Read data from i8042 port.
    317  * @param fun DDF function.
     324 *
     325 * @param fun    DDF function.
    318326 * @param buffer Data place.
    319  * @param size Data place size.
     327 * @param size   Data place size.
     328 *
    320329 * @return Bytes read.
     330 *
    321331 */
    322332static int i8042_read(ddf_fun_t *fun, char *data, size_t size)
     
    324334        assert(fun);
    325335        assert(fun->driver_data);
    326 
     336       
    327337        i8042_t *controller = fun->driver_data;
    328338        buffer_t *buffer = (fun == controller->aux_fun) ?
    329339            &controller->aux_buffer : &controller->kbd_buffer;
    330         for (size_t i = 0; i < size; ++i) {
     340       
     341        for (size_t i = 0; i < size; ++i)
    331342                *data++ = buffer_read(buffer);
    332         }
     343       
    333344        return size;
    334345}
    335346
    336347/** Handle data requests.
    337  * @param fun ddf_fun_t function.
    338  * @param id callid
     348 *
     349 * @param fun  ddf_fun_t function.
     350 * @param id   callid
    339351 * @param call IPC request.
     352 *
    340353 */
    341354void default_handler(ddf_fun_t *fun, ipc_callid_t id, ipc_call_t *call)
     
    343356        const sysarg_t method = IPC_GET_IMETHOD(*call);
    344357        const size_t size = IPC_GET_ARG1(*call);
     358       
    345359        switch (method) {
    346360        case IPC_CHAR_READ:
    347361                if (size <= 4 * sizeof(sysarg_t)) {
    348362                        sysarg_t message[4] = {};
    349                         i8042_read(fun, (char*)message, size);
     363                       
     364                        i8042_read(fun, (char *) message, size);
    350365                        async_answer_4(id, size, message[0], message[1],
    351366                            message[2], message[3]);
    352                 } else {
     367                } else
    353368                        async_answer_0(id, ELIMIT);
    354                 }
    355369                break;
    356 
     370       
    357371        case IPC_CHAR_WRITE:
    358372                if (size <= 3 * sizeof(sysarg_t)) {
    359373                        const sysarg_t message[3] = {
    360                                 IPC_GET_ARG2(*call), IPC_GET_ARG3(*call),
    361                                 IPC_GET_ARG4(*call) };
    362                         i8042_write(fun, (char*)message, size);
     374                                IPC_GET_ARG2(*call),
     375                                IPC_GET_ARG3(*call),
     376                                IPC_GET_ARG4(*call)
     377                        };
     378                       
     379                        i8042_write(fun, (char *) message, size);
    363380                        async_answer_0(id, size);
    364                 } else {
     381                } else
    365382                        async_answer_0(id, ELIMIT);
    366                 }
    367 
     383       
    368384        default:
    369385                async_answer_0(id, EINVAL);
    370386        }
    371387}
     388
    372389/**
    373390 * @}
Note: See TracChangeset for help on using the changeset viewer.