Project

General

Profile

Statistics
| Revision:

root / lab4 / mouse.h @ 70

History | View | Annotate | Download (1.85 KB)

1 68 up20180642
#ifndef MOUSE_H_INCLUDED
2
#define MOUSE_H_INCLUDED
3 53 up20180655
4 58 up20180642
#include <stdint.h>
5 53 up20180655
6 58 up20180642
/**
7
 * @brief Subscribes Mouse Interrupts and disables Minix Default IH
8
 * @param interrupt_bit Bit of Interrupt Vector that will be set when Mouse Interrupt is pending
9
 * @param interrupt_id Mouse Interrupt ID to specify the Mouse Interrupt in other calls
10
 * @return ERROR_CODE code representing the result of the operation, SUCCESS code is returned if everything is OK
11
 * @see {_ERRORS_H_::errors}
12
 */
13
int (subscribe_mouse_interrupt)(uint8_t interrupt_bit, int *interrupt_id);
14 53 up20180655
15 58 up20180642
struct packet (mouse_parse_packet)(const uint8_t *packet_bytes);
16 53 up20180655
17 58 up20180642
int (mouse_set_data_report)(int on);
18
19 70 up20180655
/**
20
 * @brief Reads data byte from mouse
21
 * <summary>
22
 * Polls the mouse till data is available for reading
23
 * </summary>
24
 * @param data Pointer to variable where byte read from mouse will be stored
25
 * @return ERROR_CODE code representing the result of the operation, SUCCESS code is returned if everything is OK
26
 * @see {_ERRORS_H_::errors}
27
 */
28
int (mouse_read_data)(uint8_t *data);
29
30
/**
31
 * @brief Issues command to mouse
32
 * <summary>
33
 * Issues command to mouse, returns error after two consecutive errors reported by the acknowledgment byte
34
 * </summary>
35
 * @param cmd Command to be issued
36
 * @return ERROR_CODE code representing the result of the operation, SUCCESS code is returned if everything is OK
37
 * @see {_ERRORS_H_::errors}
38
 */
39
int (mouse_issue_cmd)(uint32_t cmd);
40
41
/**
42
 * @brief Reads byte from mouse
43
 * <summary>
44
 * Reads byte from mouse, giving error if exceeds number of tries to read
45
 * @param byte Pointer to variable where byte read from mouse will be stored
46
 * @return ERROR_CODE code representing the result of the operation, SUCCESS code is returned if everything is OK
47
 * @see {_ERRORS_H_::errors}
48
 */
49
int (mouse_read_byte)(uint8_t *byte);
50
51 68 up20180642
#endif //MOUSE_H_INCLUDED