James Prestwood
2fe20808c2
doc: update diagnostics with [optional] tags
...
Some elements, though unlikely, are not required to be included
with the GET_STATION call that GetDiagnostics relies on. mac80211
based drivers include most of these, but other drivers may not.
To be on the safe side all properties except ConnectedBss are now
optional and may not be included.
2021-01-12 13:39:30 -06:00
James Prestwood
c3d5caec98
doc: diagnostic DBus interface definition
2021-01-11 14:22:36 -06:00
James Prestwood
aa9e6684cb
doc: document AP StartProfile
2020-11-04 13:37:29 -06:00
Andrew Zaborowski
008b29f359
doc: Fix SignalLevelAgent interface name and filename pointers
...
When the SignalLevelAgent doc blurb was moved to station-api.txt it
seems the interface was changed to Station.SignalLevelAgent in some
places but not in most and not in the code. Also fix the pointers to
the doc file.
2020-10-14 13:01:48 -05:00
James Prestwood
4cc067e58e
doc: update hostapd.conf with DRIVER_WIRED
2020-09-17 16:18:27 -05:00
James Prestwood
199b7837d4
doc: update test runner docs
2020-09-10 17:59:49 -05:00
Andrew Zaborowski
b94bc39827
doc: Document Peer.ConnectedInterface and ConnectedIP
2020-07-13 14:54:29 -05:00
Andrew Zaborowski
66f4981650
doc: Wi-Fi Display DBus API doc
2020-07-13 14:51:24 -05:00
James Prestwood
078c2d76c7
doc: document new 'Delay' property for hwsim Rules
2020-06-08 15:12:49 -05:00
Andrew Zaborowski
e1b1461a8e
doc: List possible P2P peer category/subcategory values
2020-04-24 11:10:54 -05:00
Andrew Zaborowski
c1bf85ec13
doc: Fix p2p method error names
2020-03-17 15:34:38 -05:00
Andrew Zaborowski
b216e98974
Document P2P dbus interfaces
...
Proposed minimum P2P interfaces for establishing basic connections. The
device discovery results in creation of Peer objects.
2020-01-27 14:55:09 -06:00
Torstein Husebø
759dbdd37f
treewide: fix typos
2020-01-21 16:03:28 -06:00
Denis Kenzior
2a7c4a9c3d
doc: Fix wrong interface name
...
When we moved SignalLevelAgent from Device to Station we apparently
forgot to update this particular straggler.
2020-01-18 10:58:33 -06:00
Denis Kenzior
1bc3e56431
doc: Remove empty file
2020-01-18 10:54:08 -06:00
James Prestwood
8b937f4705
doc: add CONFIG_DRIVER_NONE to hostapd config
...
This allows hostapd to be started as a standalone radius server
2020-01-06 11:18:48 -06:00
James Prestwood
e2f4031a21
doc: describe hardware passthrough feature
...
There are wiki's floating around, but I have consolidated the steps for
USB passthrough into our internal docs.
Reviewed-By: Paul Menzel <pmenzel@molgen.mpg.de>
2019-12-18 10:27:23 -06:00
Andrew Zaborowski
f909c6db26
doc: Generalize wsc-api method descriptions
2019-12-08 23:10:27 -06:00
Denis Kenzior
be5e955e65
doc: Remove stale file
2019-11-08 21:20:01 -06:00
Denis Kenzior
081f595c2a
doc: extra clarifications for properties
2019-10-28 21:23:05 -05:00
Denis Kenzior
a9c1a428b5
doc: Mark interfaces as stable
2019-10-28 21:16:07 -05:00
Denis Kenzior
ab5a1d5d7d
doc: Update APIs with the new root path
2019-10-28 11:32:23 -05:00
Marcel Holtmann
e915156be1
doc: Remove obsolete main.conf example file
2019-10-25 19:57:16 +02:00
Denis Kenzior
d12ee292aa
treewide: Use CamelCase for disable_anqp setting
2019-10-24 23:18:23 -05:00
Denis Kenzior
9a56cbe3e5
doc: Rename Autoconnect to AutoConnect
2019-10-24 12:38:50 -05:00
Denis Kenzior
8a80b30201
doc: Remove Device.WDS property
...
Allowing applications to toggle this was a bit dangerous since it could
mess with existing links. The naming was also controversial. Remove
this property for now in preparation of makig the API stable / frozen.
If needed, this functionality can be enabled some other way.
2019-10-24 11:31:03 -05:00
Denis Kenzior
2fa27e62b5
doc: Rename .InvalidArgs to .InvalidArguments
2019-10-24 10:49:13 -05:00
Denis Kenzior
79a8a1287a
doc: Change WSC api naming
...
This change removes the name WiFi from the interface name since this
term is copyrighted by the Wi-Fi Alliance and cannot be properly
attributed in such a context.
2019-10-24 10:49:09 -05:00
Denis Kenzior
966114ab3e
doc: Merge signal-level-agent-api.txt
...
into station-api.txt where it logically belongs
2019-10-23 17:43:10 -05:00
Denis Kenzior
3191c61b26
doc: Merge agent-api.txt and agent-manager.txt
2019-10-23 17:41:28 -05:00
James Prestwood
94e2769e93
doc: fix broken link in test-runner.txt
2019-10-08 14:50:19 -05:00
James Prestwood
3f13c4029a
doc: add section about regulatory.db missing
...
It was found that some distros do not ship with a regulatory.db file.
This is required to run some of the autotests, and if not found on the
system the kernel build will fail due to some of the IWD config
options which require regulatory.db.
The fix is to manually download regulatory.db from git.kernel.org and
place it in /lib/firmware.
2019-10-07 11:38:47 -05:00
Marcel Holtmann
765bb92084
build: Add skeleton manual pages for all installed binaries
2019-09-22 21:57:47 +02:00
James Prestwood
f06fdde5b1
doc: host our own hostapd .config file
...
The test-runner hostapd section continues to grow with various
options to enable. The wording for each of the options was such
that it appeared optional (for test X uncomment Y). Since anyone
running test-runner will likely want the ability to run all
tests it made sense for us to just host our own hostapd config
file that can be copied into the hostapd tree.
2019-09-16 13:50:21 -05:00
Denis Kenzior
0f337ceb51
doc: Update main.conf to reflect the default
2019-09-16 12:55:27 -05:00
Tim Kourt
c5783fed71
doc: Refine dns_resolve_method documentation
2019-09-16 12:51:09 -05:00
Tim Kourt
199e647ffd
doc: Refine enable_network_config documentation
2019-09-16 12:51:09 -05:00
Milan P. Stanić
5667227020
doc/main.conf: add short description about internal dhcp
...
added example how to use internal dhcp and resolver config
2019-08-29 12:31:12 -05:00
James Prestwood
342aeeb62b
doc: add some documentation about --shell
2019-08-28 15:55:57 -05:00
James Prestwood
7fa5eddfbc
doc: add required kernel version for anqp_disabled=false
...
The release candidates for v5.3 contain the required patches for
offchannel management frames to work properly.
2019-08-28 12:38:58 -05:00
James Prestwood
92e1838cbe
doc: update docs with hotspot name/type info
2019-08-21 14:20:15 -05:00
James Prestwood
04dc20cf5d
doc: update control_port_over_nl80211 option
2019-07-30 14:41:49 -05:00
James Prestwood
e5c87a2741
doc: update management_frame_protection option
2019-07-30 14:41:49 -05:00
James Prestwood
2f8e9b9c53
doc: clean up main.conf documentation
...
All options should now have a description which describes the
default value for each option. The example use (commented or not)
now contains the default value as well.
2019-07-30 14:41:49 -05:00
Denis Kenzior
1bc59390fa
doc: document new mac randomization options
2019-07-02 15:47:05 -05:00
James Prestwood
53d6a3b8da
doc: add hotspot documentation
2019-06-26 14:29:51 -05:00
James Prestwood
273f0d358b
doc: add disable_anqp option
...
The way IWD does ANQP depends on a recent kernel patch so its best if
we have ANQP disabled by default. In addition it has been found some
drivers do public action frames very badly, resulting in freezes or
crashes. If users are feeling brave, or are confident they're system
can handle ANQP properly they can enable this.
Enabling this option is required for Hotspot 2.0 support
2019-06-26 13:38:32 -05:00
James Prestwood
38bb528c71
doc: document ManagementFrameProtection
2019-06-10 18:33:59 -05:00
James Prestwood
24ca5a24dd
doc: update test-runner.txt with FILS options
2019-05-07 14:08:00 -05:00
Denis Kenzior
e8844358b7
doc: Add use_default_interface to main.conf
2019-05-02 10:47:45 -05:00
Tim Kourt
4ea6523b19
doc: Change interface naming after migration
2019-04-08 14:46:48 -05:00
Tim Kourt
3f41b8a1cc
doc: Document 'Autoconnect' property for known networks
2019-04-08 14:46:48 -05:00
Jonas Große Sundrup
ea56b9b41f
doc: Mention units for options in [Blacklist]
2019-04-04 17:02:19 -05:00
Tim Kourt
713408b831
doc: Document disable_roaming_scan setting
2019-04-01 18:38:21 -05:00
James Prestwood
f09fc78aeb
doc: document roam_rssi_threshold conf option
2019-03-21 10:57:09 -05:00
Jason Phan
2eb54d4adc
doc: update kernel guide links
...
The patch submission and coding style guide links were outdated.
2019-03-20 10:50:00 -05:00
James Prestwood
9887c376b7
doc: add [General] group to main.conf
...
The pattern in main.conf made it appear that ControlPortOverNL80211
was part of the EAPoL group, which it is not.
2019-03-19 13:58:39 -05:00
Tim Kourt
1677f6b046
doc: Update software versions
2019-03-08 11:10:17 -06:00
Tim Kourt
c26af17ca0
doc: Add config options for High Throughput
2019-03-08 11:09:29 -06:00
Denis Kenzior
9e11175cf8
doc: update coding style
...
To add forward-declaration of statics rule. This rule is already
enforced, but for some reason the document in iwd did not have this rule
in it (it is in other projects, like oFono)
2019-02-28 09:15:46 -06:00
James Prestwood
ba9990a94a
doc: document rank_5g_factor
2019-02-26 12:35:53 -06:00
Denis Kenzior
261eeb511b
doc: Document ControlPortOverNL80211 option
2019-02-18 11:33:10 -06:00
James Prestwood
e9f53a08b4
test-runner: document creation of /var/lib/iwd
2019-01-24 17:24:42 -06:00
James Prestwood
fc557136c5
doc: document BSS blacklist config options
2019-01-24 17:22:50 -06:00
Tim Kourt
b41729d608
doc: Add setting to disable MAC randomization
2019-01-16 13:18:57 -06:00
Denis Kenzior
12189fcf39
conf: Increase default eapool handshake timeout
2019-01-09 21:13:53 -06:00
James Prestwood
6bf79dbb8b
doc: removed OWE TODO and added OWE to features
2018-11-19 12:10:58 -06:00
Tim Kourt
7b8c069383
doc: Add option to disable periodic scan into main.conf
2018-11-16 16:42:00 -06:00
Denis Kenzior
fbcacce0a3
doc: Tweak GetHiddenStations API
...
Station was really a misnomer, it should have been AccessPoint. Also
mark the API as experimental. It will be moved to the Diagnostics
interface eventually.
2018-11-09 13:44:48 -06:00
James Prestwood
635c530e5e
doc: updated features to include SAE
2018-11-05 12:08:31 -06:00
James Prestwood
e12b24d218
doc: updated features to include AP/AdHoc modes
2018-11-05 12:08:11 -06:00
Marcel Holtmann
36cedb1f46
doc: Add notes about running hostapd in a network namespace
2018-10-16 17:46:33 +02:00
Marcel Holtmann
6dc2706459
doc: Document use_pae_group_addr=1 option for wired 802.1x testing
2018-10-16 14:51:29 +02:00
Tim Kourt
2b615e8fe7
doc: add hostapd CONFIG for fast roaming
2018-10-02 15:15:09 -05:00
Tim Kourt
7606ea95b0
doc: add CONFIG for hostapd
2018-10-02 15:10:55 -05:00
Marcel Holtmann
ea20559599
tools: Change net.connman.iwd.hwsim to net.connman.hwsim
2018-09-14 15:27:57 +02:00
Marcel Holtmann
5be8be19a6
doc: Add instructions for 802.1x wired testing
2018-09-14 13:56:20 +02:00
James Prestwood
60211f9ae8
docs: added hostapd config options for SAE
2018-09-13 16:42:09 -05:00
Krzysztof Wilk
d0cf6a6822
doc: Fix Interface for Ad-Hoc DBus API
2018-08-28 10:17:56 -05:00
Krzysztof Wilk
bd0e33906f
doc: Fix Interface for Access Point DBus API
2018-08-27 11:46:42 -05:00
Denis Kenzior
0453308134
doc: Split Device into Device & Station apis
2018-08-15 16:54:14 -05:00
Denis Kenzior
fb20c3a003
doc: Mark Network.Type property as readonly
2018-08-14 13:29:20 -05:00
Denis Kenzior
be821a80d8
doc: Add Network.KnownNetwork property
2018-08-14 13:29:08 -05:00
Denis Kenzior
70a3101319
doc: Rename SignalLevelChanged to Changed
2018-08-13 20:40:59 -05:00
Andrew Zaborowski
cbbba5cc5a
doc: Add the KnownNetwork.Hidden property
2018-08-10 09:43:27 -05:00
Denis Kenzior
5011637df2
doc: Add Adapter.SupportedModes property
2018-08-07 17:07:49 -05:00
Denis Kenzior
1d52f1a233
doc: Reword Device.Mode property documentation
2018-08-07 17:07:31 -05:00
Andrew Zaborowski
7d3656858f
doc: Document new KnownNetwork API, remove old
2018-07-31 11:52:59 -05:00
Tim Kourt
de013cf92b
doc: add Started property to ap and adhoc
2018-07-30 09:01:30 -05:00
James Prestwood
6051bdb360
docs: added documentation for Ad-Hoc interface
2018-07-17 16:59:19 -05:00
Denis Kenzior
ec46f8da02
doc: Update ConnectHiddenNetwork api documentation
2018-07-13 11:54:14 -05:00
James Prestwood
d33b3e0ee6
doc: updated device-api and added ap-api
...
Added "Mode" documentation for device API, as well as added
a new ap-api.txt to document the AccessPoint interface.
2018-07-03 11:33:48 -05:00
Tim Kourt
b132e36978
doc: add new errors to ConnectHiddenNetwork method
2018-06-29 13:46:06 -05:00
Antonio Quartulli
233fa6259d
doc: add WDS property to Device interface
2018-06-13 11:41:59 -05:00
Tim Kourt
86879dda7c
doc: add ConnectHiddenNetwork API call
2018-06-05 13:02:00 -05:00
Tim Kourt
ff5665beb8
doc: add CONFIG entries for hostapd
2018-05-21 17:42:48 -05:00
Andrew Zaborowski
b4b2a45583
doc: Add new Agent request types
2018-04-19 11:49:37 -05:00
James Prestwood
ad93f4d203
doc: add list of EAP methods to features.txt
2018-04-06 10:30:50 -05:00
James Prestwood
cb1ed123e4
doc: add new eapol setting to doc/main.conf
2018-04-02 13:54:25 -05:00
James Prestwood
592d60c28e
TODO: Mark SA Query related tasks as done
2018-04-02 13:35:33 -05:00