source: mainline/uspace/drv/hid/ps2mouse/main.c

Last change on this file was c8ea6eca, checked in by Jakub Jermar <jakub@…>, 7 years ago

Improve doxygen documentation

  • Property mode set to 100644
File size: 3.0 KB
Line 
1/*
2 * Copyright (c) 2011 Jan Vesely
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 ps2mouse
30 * @{
31 */
32/** @file
33 * @brief PS/2 mouse driver
34 */
35
36#include <inttypes.h>
37#include <ddf/driver.h>
38#include <device/hw_res_parsed.h>
39#include <errno.h>
40#include <str_error.h>
41#include <ddf/log.h>
42#include <stdio.h>
43
44#include "ps2mouse.h"
45
46#define NAME "ps2mouse"
47
48static errno_t mouse_add(ddf_dev_t *device);
49
50/** DDF driver ops. */
51static driver_ops_t mouse_driver_ops = {
52 .dev_add = mouse_add,
53};
54
55/** DDF driver structure. */
56static driver_t mouse_driver = {
57 .name = NAME,
58 .driver_ops = &mouse_driver_ops
59};
60
61/** Initialize global driver structures (NONE).
62 *
63 * @param[in] argc Nmber of arguments in argv vector (ignored).
64 * @param[in] argv Cmdline argument vector (ignored).
65 * @return Error code.
66 *
67 * Driver debug level is set here.
68 */
69int main(int argc, char *argv[])
70{
71 printf(NAME ": HelenOS ps/2 mouse driver.\n");
72 ddf_log_init(NAME);
73 return ddf_driver_main(&mouse_driver);
74}
75
76/** Initialize a new ddf driver instance
77 *
78 * @param[in] device DDF instance of the device to initialize.
79 * @return Error code.
80 */
81static errno_t mouse_add(ddf_dev_t *device)
82{
83 errno_t rc;
84
85 if (!device)
86 return EINVAL;
87
88 ps2_mouse_t *mouse = ddf_dev_data_alloc(device, sizeof(ps2_mouse_t));
89 if (mouse == NULL) {
90 ddf_msg(LVL_ERROR, "Failed to allocate mouse driver instance.");
91 return ENOMEM;
92 }
93
94 rc = ps2_mouse_init(mouse, device);
95 if (rc != EOK) {
96 ddf_msg(LVL_ERROR, "Failed to initialize mouse driver: %s.",
97 str_error(rc));
98 return rc;
99 }
100
101 ddf_msg(LVL_NOTE, "Controlling '%s' (%" PRIun ").",
102 ddf_dev_get_name(device), ddf_dev_get_handle(device));
103 return EOK;
104}
105/**
106 * @}
107 */
Note: See TracBrowser for help on using the repository browser.