projects / deliverable / linux.git / blame
| Commit | Line | Data |
|---|---|---|
| 5377d91f MH |
1 | .. -*- coding: utf-8; mode: rst -*- |
| 2 | ||
| 3 | .. _FE_GET_EVENT: | |
| 4 | ||
| 5 | ************ | |
| 6 | FE_GET_EVENT | |
| 7 | ************ | |
| 8 | ||
| 9 | DESCRIPTION | |
| 10 | ||
| 11 | This ioctl call returns a frontend event if available. If an event is | |
| 12 | not available, the behavior depends on whether the device is in blocking | |
| 13 | or non-blocking mode. In the latter case, the call fails immediately | |
| 14 | with errno set to EWOULDBLOCK. In the former case, the call blocks until | |
| 15 | an event becomes available. | |
| 16 | ||
| 17 | SYNOPSIS | |
| 18 | ||
| 19 | int ioctl(int fd, int request = QPSK_GET_EVENT, struct | |
| 20 | dvb_frontend_event *ev); | |
| 21 | ||
| 22 | PARAMETERS | |
| 23 | ||
| 24 | ||
| 25 | ||
| 26 | .. flat-table:: | |
| 27 | :header-rows: 0 | |
| 28 | :stub-columns: 0 | |
| 29 | ||
| 30 | ||
| 31 | - .. row 1 | |
| 32 | ||
| 33 | - int fd | |
| 34 | ||
| 35 | - File descriptor returned by a previous call to open(). | |
| 36 | ||
| 37 | - .. row 2 | |
| 38 | ||
| 39 | - int request | |
| 40 | ||
| 7347081e | 41 | - Equals :ref:`FE_GET_EVENT` for this command. |
| 5377d91f MH |
42 | |
| 43 | - .. row 3 | |
| 44 | ||
| 45 | - struct dvb_frontend_event *ev | |
| 46 | ||
| 47 | - Points to the location where the event, | |
| 48 | ||
| 49 | - .. row 4 | |
| 50 | ||
| 51 | - | |
| 52 | - if any, is to be stored. | |
| 53 | ||
| 54 | ||
| 55 | RETURN VALUE | |
| 56 | ||
| 57 | On success 0 is returned, on error -1 and the ``errno`` variable is set | |
| 58 | appropriately. The generic error codes are described at the | |
| 59 | :ref:`Generic Error Codes <gen-errors>` chapter. | |
| 60 | ||
| 61 | ||
| 62 | ||
| 63 | .. flat-table:: | |
| 64 | :header-rows: 0 | |
| 65 | :stub-columns: 0 | |
| 66 | ||
| 67 | ||
| 68 | - .. row 1 | |
| 69 | ||
| 70 | - EWOULDBLOCK | |
| 71 | ||
| 72 | - There is no event pending, and the device is in non-blocking mode. | |
| 73 | ||
| 74 | - .. row 2 | |
| 75 | ||
| 76 | - EOVERFLOW | |
| 77 | ||
| 78 | - Overflow in event queue - one or more events were lost. | |
| 79 | ||
| 80 | ||
| 81 | ||
| 82 | ||
| 83 | .. ------------------------------------------------------------------------------ | |
| 84 | .. This file was automatically converted from DocBook-XML with the dbxml | |
| 85 | .. library (https://github.com/return42/sphkerneldoc). The origin XML comes | |
| 86 | .. from the linux kernel, refer to: | |
| 87 | .. | |
| 88 | .. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook | |
| 89 | .. ------------------------------------------------------------------------------ |