1 .. SPDX-License-Identifier: GFDL-1.1-no-invari 1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2 .. c:namespace:: DTV.ca 2 .. c:namespace:: DTV.ca
3 3
4 .. _ca_fopen: 4 .. _ca_fopen:
5 5
6 ==================== 6 ====================
7 Digital TV CA open() 7 Digital TV CA open()
8 ==================== 8 ====================
9 9
10 Name 10 Name
11 ---- 11 ----
12 12
13 Digital TV CA open() 13 Digital TV CA open()
14 14
15 Synopsis 15 Synopsis
16 -------- 16 --------
17 17
18 .. c:function:: int open(const char *name, int 18 .. c:function:: int open(const char *name, int flags)
19 19
20 Arguments 20 Arguments
21 --------- 21 ---------
22 22
23 ``name`` 23 ``name``
24 Name of specific Digital TV CA device. 24 Name of specific Digital TV CA device.
25 25
26 ``flags`` 26 ``flags``
27 A bit-wise OR of the following flags: 27 A bit-wise OR of the following flags:
28 28
29 .. tabularcolumns:: |p{2.5cm}|p{15.0cm}| 29 .. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
30 30
31 .. flat-table:: 31 .. flat-table::
32 :header-rows: 0 32 :header-rows: 0
33 :stub-columns: 0 33 :stub-columns: 0
34 :widths: 1 16 34 :widths: 1 16
35 35
36 - - ``O_RDONLY`` 36 - - ``O_RDONLY``
37 - read-only access 37 - read-only access
38 38
39 - - ``O_RDWR`` 39 - - ``O_RDWR``
40 - read/write access 40 - read/write access
41 41
42 - - ``O_NONBLOCK`` 42 - - ``O_NONBLOCK``
43 - open in non-blocking mode 43 - open in non-blocking mode
44 (blocking mode is the default) 44 (blocking mode is the default)
45 45
46 Description 46 Description
47 ----------- 47 -----------
48 48
49 This system call opens a named ca device (e.g. 49 This system call opens a named ca device (e.g. ``/dev/dvb/adapter?/ca?``)
50 for subsequent use. 50 for subsequent use.
51 51
52 When an ``open()`` call has succeeded, the dev 52 When an ``open()`` call has succeeded, the device will be ready for use. The
53 significance of blocking or non-blocking mode 53 significance of blocking or non-blocking mode is described in the
54 documentation for functions where there is a d 54 documentation for functions where there is a difference. It does not
55 affect the semantics of the ``open()`` call it 55 affect the semantics of the ``open()`` call itself. A device opened in
56 blocking mode can later be put into non-blocki 56 blocking mode can later be put into non-blocking mode (and vice versa)
57 using the ``F_SETFL`` command of the ``fcntl`` 57 using the ``F_SETFL`` command of the ``fcntl`` system call. This is a
58 standard system call, documented in the Linux 58 standard system call, documented in the Linux manual page for fcntl.
59 Only one user can open the CA Device in ``O_RD 59 Only one user can open the CA Device in ``O_RDWR`` mode. All other
60 attempts to open the device in this mode will 60 attempts to open the device in this mode will fail, and an error code
61 will be returned. 61 will be returned.
62 62
63 Return Value 63 Return Value
64 ------------ 64 ------------
65 65
66 On success 0 is returned. 66 On success 0 is returned.
67 67
68 On error -1 is returned, and the ``errno`` var 68 On error -1 is returned, and the ``errno`` variable is set
69 appropriately. 69 appropriately.
70 70
71 Generic error codes are described at the 71 Generic error codes are described at the
72 :ref:`Generic Error Codes <gen-errors>` chapte 72 :ref:`Generic Error Codes <gen-errors>` chapter.
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.