bnxt: Add support for magic packet based Wake-on-LAN.
ClosedPublic
Actions

Authored by venkatkumar.duvvuru_broadcom.com on Mar 24 2017, 7:09 AM.

Details

Reviewers

shurd
sbruno

Commits

rS316616: bnxt(4): add support for WOL Magic.

Summary

To enable WoL:-
sysctl dev.bnxt.<if_id>.wol=1

To disable WoL:-
sysctl dev.bnxt.<if_id>.wol=0

Diff Detail

Repository

rS FreeBSD src repository - subversion

Lint

Lint Passed

Unit

No Test Coverage

Build Status

Buildable 8582
Build 8896: arc lint + arc unit

Event Timeline

venkatkumar.duvvuru_broadcom.com created this revision.Mar 24 2017, 7:09 AM

Harbormaster completed remote builds in B8270: Diff 26623.Mar 24 2017, 7:09 AM

Herald added subscribers: Contributor Reviews (src), imp. · View Herald TranscriptMar 24 2017, 7:09 AM

venkatkumar.duvvuru_broadcom.com added reviewers: shurd, sbruno.Mar 24 2017, 7:11 AM

In order for iflib and the network stack to know about WOL, you need to set the capabilities for WOL in the driver. I didn't see this done in this patch and I don't see it being done in the driver in the tree.

An example of what I'm referring to can be seen in sys/dev/e1000/if_em.c::2630

This lets the stack know that the WOL capabilities are enabled.

This revision now requires changes to proceed.Mar 27 2017, 2:06 PM

bnxt: Add support for magic packet based Wake-on-LAN.

Harbormaster completed remote builds in B8582: Diff 27178.Apr 7 2017, 1:51 PM

Closed by commit rS316616: bnxt(4): add support for WOL Magic. (authored by sbruno). · Explain WhyApr 7 2017, 4:16 PM

This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

Path

Size

sys/

dev/

bnxt/

8 lines

3 lines

64 lines

82 lines

Diff 27178

View Options

sys/dev/bnxt/bnxt.h

Show All 22 Lines

.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)

.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT

.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY

.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF

.\" SUCH DAMAGE.

.\"

.\" $FreeBSD$

.\"

.Dd January 3, 2021

.Dd November 15, 2021

.Dt LIBCASPER 3

.Os

.Sh NAME

.Nm cap_init ,

.Nm cap_wrap ,

.Nm cap_unwrap ,

.Nm cap_sock ,

.Nm cap_clone ,

Show All 33 Lines

.Fn cap_recv_nvlist "const cap_channel_t *chan"

.Ft "nvlist_t *"

.Fn cap_xfer_nvlist "const cap_channel_t *chan" "nvlist_t *nvl"

.Ft "cap_channel_t *"

.Fn cap_service_open "const cap_channel_t *chan" "const char *name"

.Sh DESCRIPTION

The

.Nm libcasper

library allows to manage application capabilities through the casper process.

library provides for the control of application capabilities through

the casper process.

oshogboUnsubmitted

Done

This line is longer then 80 lines.

oshogbo: This line is longer then 80 lines.

.Pp

The application capability (represented by the

An application capability, represented by the

.Vt cap_channel_t

type) is a communication channel between the caller and the casper process

type, is a communication channel between the caller and the casper

daemon or an instance of one of its services.

daemon or an instance of one of the daemon's services.

A capability to the casper process obtained with the

A capability to the casper process, obtained with the

.Fn cap_init

function allows to create capabilities to casper's services via the

function, allows a program to create capabilities to access

the casper daemon's services via the

0mpUnsubmitted

Done

acacce looks like a typo

0mp: acacce looks like a typo

.Fn cap_service_open

function.

.Pp

The

.Fn cap_init

function opens capability to the casper process.

function instantiates a capability to allow a program to access

the casper daemon.

.Pp

The

.Fn cap_wrap

function creates

function creates a

.Vt cap_channel_t

based on the given socket.

based on the socket supplied in the call.

The function is used when capability is inherited through

The function is used when a capability is inherited through the

.Xr execve 2

or send over

system call,

or sent over a

.Xr unix 4

domain socket as a regular file descriptor and has to be represented as

domain socket as a file descriptor,

.Vt cap_channel_t

and has to be converted into a

oshogboUnsubmitted

Done

and?

oshogbo: and?

again.

.Vt cap_channel_t .

The

.Fa flags

argument defines the channel behavior.

The supported flags are:

.Bl -ohang -offset indent

.It CASPER_NO_UNIQ

The communication between process and casper uses no unique version of nvlist.

The communication between the process and the casper daemon no

0mpUnsubmitted

Done

The word *uses* disappeared in the process.

0mp: The word *uses* disappeared in the process.

unique version of nvlist.

oshogboUnsubmitted

Done

This line is longer then 80, I'm not sure if this is a bug anymore.

oshogbo: This line is longer then 80, I'm not sure if this is a bug anymore.

.El

.Pp

The

.Fn cap_unwrap

function is the opposite of the

function returns the

oshogboUnsubmitted

Done

The domain socket may or may not be provided in cap_wrap.
The Casper daemon may create a socket using cap_init and you also can obtain this descriptor.
Maybe something like:

The
.Fn cap_unwrap
function returns the
.Xr unix 4
domain socket used by the daemon service,
and frees the
.Vt cap_channel_t
structure.

oshogbo: The domain socket may or may not be provided in cap_wrap. The Casper daemon may create a socket…

.Fn cap_wrap

function.

It frees the

.Vt cap_channel_t

structure and returns

.Xr unix 4

domain socket associated with it.

domain socket used by the daemon service,

and frees the

.Vt cap_channel_t

structure.

.Pp

The

.Fn cap_clone

function clones the given capability.

function returns a clone of the capability passed as its only argument.

.Pp

The

.Fn cap_close

function closes the given capability.

function closes, and frees, the given capability.

.Pp

The

.Fn cap_sock

function returns

function returns the

.Xr unix 4

domain socket descriptor associated with the given capability for use with

system calls like

system calls such as:

.Xr kevent 2 ,

.Xr poll 2

0mpUnsubmitted

Done

.Xr kevent 2 ,

- .Xr poll 2

+ .Xr poll 2 ,

and

.Xr select 2 .

0mp:

and

.Xr select 2 .

.Pp

The

.Fn cap_limit_get

function stores current limits of the given capability in the

function stores the current limits of the given capability in the

.Fa limitsp

argument.

If the function return

If the function returns

.Va 0

and

.Dv NULL

is stored in

is stored in the

.Fa limitsp

it means there are no limits set.

argument,

there are no limits set.

.Pp

The

.Fn cap_limit_set

function sets limits for the given capability.

The limits are provided as a

The limits are provided as an

.Xr nvlist 9 .

The exact format depends on the service the capability represents.

The exact format of the limits depends on the service that the

capability represents.

.Fn cap_limit_set

frees the limits regardless of whether the operation succeeds or fails.

frees the limits passed to the call,

whether or not the operation succeeds or fails.

.Pp

The

.Fn cap_send_nvlist

function sends the given

.Xr nvlist 9

over the given capability.

This is low level interface to communicate with casper services.

This is a low level interface to communicate with casper services.

Most services should provide higher level API.

It is expected that most services will provide a higher level API.

.Pp

The

.Fn cap_recv_nvlist

function receives the given

.Xr nvlist 9

over the given capability.

.Pp

The

.Fn cap_xfer_nvlist

function sends the given

.Xr nvlist 9 ,

destroys it and receives new

destroys it,

and receives a new

oshogboUnsubmitted

Done

I'm not sure what the convention is but in other cases after Oxford Comma you put a new line.

oshogbo: I'm not sure what the convention is but in other cases after Oxford Comma you put a new line.

.Xr nvlist 9

in response over the given capability.

It does not matter if the function succeeds or fails, the

.Xr nvlist 9

given for sending will always be destroyed once the function returns.

given for sending will always be destroyed before the function returns.

.Pp

The

.Fn cap_service_open

function opens casper service of the given name through casper capability

function opens the casper service named in the call using

obtained via the

the casper capability obtained via the

.Fn cap_init

function.

The function returns capability that provides access to opened service.

The

.Fn cap_service_open

function returns a capability that provides access to the opened service.

Casper supports the following services in the base system:

.Pp

.Bl -tag -width "system.random" -compact -offset indent

.It system.dns

provides DNS libc compatible API

provides libc compatible DNS API

.It system.grp

provides

provides a

.Xr getgrent 3

compatible API

.It system.net

provides network libc compatible API

provides a libc compatible network API

.It system.pwd

provides

provides a

.Xr getpwent 3

compatible API

.It system.sysctl

provides

provides a

.Xr sysctlbyname 3

compatible API

.It system.syslog

provides

provides a

.Xr syslog 3

compatible API

.El

.Sh RETURN VALUES

The

.Fn cap_clone ,

.Fn cap_init ,

.Fn cap_recv_nvlist ,

▲ Show 20 Lines • Show All 59 Lines • Show Last 20 Lines

View Options

sys/dev/bnxt/bnxt_hwrm.h

Show All 22 Lines

.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)

.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT

.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY

.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF

.\" SUCH DAMAGE.

.\"

.\" $FreeBSD$

.\"

.Dd January 3, 2021

.Dd November 15, 2021

.Dt LIBCASPER 3

.Os

.Sh NAME

.Nm cap_init ,

.Nm cap_wrap ,

.Nm cap_unwrap ,

.Nm cap_sock ,

.Nm cap_clone ,

Show All 33 Lines

.Fn cap_recv_nvlist "const cap_channel_t *chan"

.Ft "nvlist_t *"

.Fn cap_xfer_nvlist "const cap_channel_t *chan" "nvlist_t *nvl"

.Ft "cap_channel_t *"

.Fn cap_service_open "const cap_channel_t *chan" "const char *name"

.Sh DESCRIPTION

The

.Nm libcasper

library allows to manage application capabilities through the casper process.

library provides for the control of application capabilities through

the casper process.

oshogboUnsubmitted

Done

This line is longer then 80 lines.

oshogbo: This line is longer then 80 lines.

.Pp

The application capability (represented by the

An application capability, represented by the

.Vt cap_channel_t

type) is a communication channel between the caller and the casper process

type, is a communication channel between the caller and the casper

daemon or an instance of one of its services.

daemon or an instance of one of the daemon's services.

A capability to the casper process obtained with the

A capability to the casper process, obtained with the

.Fn cap_init

function allows to create capabilities to casper's services via the

function, allows a program to create capabilities to access

the casper daemon's services via the

0mpUnsubmitted

Done

acacce looks like a typo

0mp: acacce looks like a typo

.Fn cap_service_open

function.

.Pp

The

.Fn cap_init

function opens capability to the casper process.

function instantiates a capability to allow a program to access

the casper daemon.

.Pp

The

.Fn cap_wrap

function creates

function creates a

.Vt cap_channel_t

based on the given socket.

based on the socket supplied in the call.

The function is used when capability is inherited through

The function is used when a capability is inherited through the

.Xr execve 2

or send over

system call,

or sent over a

.Xr unix 4

domain socket as a regular file descriptor and has to be represented as

domain socket as a file descriptor,

.Vt cap_channel_t

and has to be converted into a

oshogboUnsubmitted

Done

and?

oshogbo: and?

again.

.Vt cap_channel_t .

The

.Fa flags

argument defines the channel behavior.

The supported flags are:

.Bl -ohang -offset indent

.It CASPER_NO_UNIQ

The communication between process and casper uses no unique version of nvlist.

The communication between the process and the casper daemon no

0mpUnsubmitted

Done

The word *uses* disappeared in the process.

0mp: The word *uses* disappeared in the process.

unique version of nvlist.

oshogboUnsubmitted

Done

This line is longer then 80, I'm not sure if this is a bug anymore.

oshogbo: This line is longer then 80, I'm not sure if this is a bug anymore.

.El

.Pp

The

.Fn cap_unwrap

function is the opposite of the

function returns the

oshogboUnsubmitted

Done

The domain socket may or may not be provided in cap_wrap.
The Casper daemon may create a socket using cap_init and you also can obtain this descriptor.
Maybe something like:

The
.Fn cap_unwrap
function returns the
.Xr unix 4
domain socket used by the daemon service,
and frees the
.Vt cap_channel_t
structure.

oshogbo: The domain socket may or may not be provided in cap_wrap. The Casper daemon may create a socket…

.Fn cap_wrap

function.

It frees the

.Vt cap_channel_t

structure and returns

.Xr unix 4

domain socket associated with it.

domain socket used by the daemon service,

and frees the

.Vt cap_channel_t

structure.

.Pp

The

.Fn cap_clone

function clones the given capability.

function returns a clone of the capability passed as its only argument.

.Pp

The

.Fn cap_close

function closes the given capability.

function closes, and frees, the given capability.

.Pp

The

.Fn cap_sock

function returns

function returns the

.Xr unix 4

domain socket descriptor associated with the given capability for use with

system calls like

system calls such as:

.Xr kevent 2 ,

.Xr poll 2

0mpUnsubmitted

Done

.Xr kevent 2 ,

- .Xr poll 2

+ .Xr poll 2 ,

and

.Xr select 2 .

0mp:

and

.Xr select 2 .

.Pp

The

.Fn cap_limit_get

function stores current limits of the given capability in the

function stores the current limits of the given capability in the

.Fa limitsp

argument.

If the function return

If the function returns

.Va 0

and

.Dv NULL

is stored in

is stored in the

.Fa limitsp

it means there are no limits set.

argument,

there are no limits set.

.Pp

The

.Fn cap_limit_set

function sets limits for the given capability.

The limits are provided as a

The limits are provided as an

.Xr nvlist 9 .

The exact format depends on the service the capability represents.

The exact format of the limits depends on the service that the

capability represents.

.Fn cap_limit_set

frees the limits regardless of whether the operation succeeds or fails.

frees the limits passed to the call,

whether or not the operation succeeds or fails.

.Pp

The

.Fn cap_send_nvlist

function sends the given

.Xr nvlist 9

over the given capability.

This is low level interface to communicate with casper services.

This is a low level interface to communicate with casper services.

Most services should provide higher level API.

It is expected that most services will provide a higher level API.

.Pp

The

.Fn cap_recv_nvlist

function receives the given

.Xr nvlist 9

over the given capability.

.Pp

The

.Fn cap_xfer_nvlist

function sends the given

.Xr nvlist 9 ,

destroys it and receives new

destroys it,

and receives a new

oshogboUnsubmitted

Done

I'm not sure what the convention is but in other cases after Oxford Comma you put a new line.

oshogbo: I'm not sure what the convention is but in other cases after Oxford Comma you put a new line.

.Xr nvlist 9

in response over the given capability.

It does not matter if the function succeeds or fails, the

.Xr nvlist 9

given for sending will always be destroyed once the function returns.

given for sending will always be destroyed before the function returns.

.Pp

The

.Fn cap_service_open

function opens casper service of the given name through casper capability

function opens the casper service named in the call using

obtained via the

the casper capability obtained via the

.Fn cap_init

function.

The function returns capability that provides access to opened service.

The

.Fn cap_service_open

function returns a capability that provides access to the opened service.

Casper supports the following services in the base system:

.Pp

.Bl -tag -width "system.random" -compact -offset indent

.It system.dns

provides DNS libc compatible API

provides libc compatible DNS API

.It system.grp

provides

provides a

.Xr getgrent 3

compatible API

.It system.net

provides network libc compatible API

provides a libc compatible network API

.It system.pwd

provides

provides a

.Xr getpwent 3

compatible API

.It system.sysctl

provides

provides a

.Xr sysctlbyname 3

compatible API

.It system.syslog

provides

provides a

.Xr syslog 3

compatible API

.El

.Sh RETURN VALUES

The

.Fn cap_clone ,

.Fn cap_init ,

.Fn cap_recv_nvlist ,

▲ Show 20 Lines • Show All 59 Lines • Show Last 20 Lines

View Options

sys/dev/bnxt/bnxt_hwrm.c

Show All 22 Lines

.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)

.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT

.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY

.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF

.\" SUCH DAMAGE.

.\"

.\" $FreeBSD$

.\"

.Dd January 3, 2021

.Dd November 15, 2021

.Dt LIBCASPER 3

.Os

.Sh NAME

.Nm cap_init ,

.Nm cap_wrap ,

.Nm cap_unwrap ,

.Nm cap_sock ,

.Nm cap_clone ,

Show All 33 Lines

.Fn cap_recv_nvlist "const cap_channel_t *chan"

.Ft "nvlist_t *"

.Fn cap_xfer_nvlist "const cap_channel_t *chan" "nvlist_t *nvl"

.Ft "cap_channel_t *"

.Fn cap_service_open "const cap_channel_t *chan" "const char *name"

.Sh DESCRIPTION

The

.Nm libcasper

library allows to manage application capabilities through the casper process.

library provides for the control of application capabilities through

the casper process.

oshogboUnsubmitted

Done

This line is longer then 80 lines.

oshogbo: This line is longer then 80 lines.

.Pp

The application capability (represented by the

An application capability, represented by the

.Vt cap_channel_t

type) is a communication channel between the caller and the casper process

type, is a communication channel between the caller and the casper

daemon or an instance of one of its services.

daemon or an instance of one of the daemon's services.

A capability to the casper process obtained with the

A capability to the casper process, obtained with the

.Fn cap_init

function allows to create capabilities to casper's services via the

function, allows a program to create capabilities to access

the casper daemon's services via the

0mpUnsubmitted

Done

acacce looks like a typo

0mp: acacce looks like a typo

.Fn cap_service_open

function.

.Pp

The

.Fn cap_init

function opens capability to the casper process.

function instantiates a capability to allow a program to access

the casper daemon.

.Pp

The

.Fn cap_wrap

function creates

function creates a

.Vt cap_channel_t

based on the given socket.

based on the socket supplied in the call.

The function is used when capability is inherited through

The function is used when a capability is inherited through the

.Xr execve 2

or send over

system call,

or sent over a

.Xr unix 4

domain socket as a regular file descriptor and has to be represented as

domain socket as a file descriptor,

.Vt cap_channel_t

and has to be converted into a

oshogboUnsubmitted

Done

and?

oshogbo: and?

again.

.Vt cap_channel_t .

The

.Fa flags

argument defines the channel behavior.

The supported flags are:

.Bl -ohang -offset indent

.It CASPER_NO_UNIQ

The communication between process and casper uses no unique version of nvlist.

The communication between the process and the casper daemon no

0mpUnsubmitted

Done

The word *uses* disappeared in the process.

0mp: The word *uses* disappeared in the process.

unique version of nvlist.

oshogboUnsubmitted

Done

This line is longer then 80, I'm not sure if this is a bug anymore.

oshogbo: This line is longer then 80, I'm not sure if this is a bug anymore.

.El

.Pp

The

.Fn cap_unwrap

function is the opposite of the

function returns the

oshogboUnsubmitted

Done

The domain socket may or may not be provided in cap_wrap.
The Casper daemon may create a socket using cap_init and you also can obtain this descriptor.
Maybe something like:

The
.Fn cap_unwrap
function returns the
.Xr unix 4
domain socket used by the daemon service,
and frees the
.Vt cap_channel_t
structure.

oshogbo: The domain socket may or may not be provided in cap_wrap. The Casper daemon may create a socket…

.Fn cap_wrap

function.

It frees the

.Vt cap_channel_t

structure and returns

.Xr unix 4

domain socket associated with it.

domain socket used by the daemon service,

and frees the

.Vt cap_channel_t

structure.

.Pp

The

.Fn cap_clone

function clones the given capability.

function returns a clone of the capability passed as its only argument.

.Pp

The

.Fn cap_close

function closes the given capability.

function closes, and frees, the given capability.

.Pp

The

.Fn cap_sock

function returns

function returns the

.Xr unix 4

domain socket descriptor associated with the given capability for use with

system calls like

system calls such as:

.Xr kevent 2 ,

.Xr poll 2

0mpUnsubmitted

Done

.Xr kevent 2 ,

- .Xr poll 2

+ .Xr poll 2 ,

and

.Xr select 2 .

0mp:

and

.Xr select 2 .

.Pp

The

.Fn cap_limit_get

function stores current limits of the given capability in the

function stores the current limits of the given capability in the

.Fa limitsp

argument.

If the function return

If the function returns

.Va 0

and

.Dv NULL

is stored in

is stored in the

.Fa limitsp

it means there are no limits set.

argument,

there are no limits set.

.Pp

The

.Fn cap_limit_set

function sets limits for the given capability.

The limits are provided as a

The limits are provided as an

.Xr nvlist 9 .

The exact format depends on the service the capability represents.

The exact format of the limits depends on the service that the

capability represents.

.Fn cap_limit_set

frees the limits regardless of whether the operation succeeds or fails.

frees the limits passed to the call,

whether or not the operation succeeds or fails.

.Pp

The

.Fn cap_send_nvlist

function sends the given

.Xr nvlist 9

over the given capability.

This is low level interface to communicate with casper services.

This is a low level interface to communicate with casper services.

Most services should provide higher level API.

It is expected that most services will provide a higher level API.

.Pp

The

.Fn cap_recv_nvlist

function receives the given

.Xr nvlist 9

over the given capability.

.Pp

The

.Fn cap_xfer_nvlist

function sends the given

.Xr nvlist 9 ,

destroys it and receives new

destroys it,

and receives a new

oshogboUnsubmitted

Done

I'm not sure what the convention is but in other cases after Oxford Comma you put a new line.

oshogbo: I'm not sure what the convention is but in other cases after Oxford Comma you put a new line.

.Xr nvlist 9

in response over the given capability.

It does not matter if the function succeeds or fails, the

.Xr nvlist 9

given for sending will always be destroyed once the function returns.

given for sending will always be destroyed before the function returns.

.Pp

The

.Fn cap_service_open

function opens casper service of the given name through casper capability

function opens the casper service named in the call using

obtained via the

the casper capability obtained via the

.Fn cap_init

function.

The function returns capability that provides access to opened service.

The

.Fn cap_service_open

function returns a capability that provides access to the opened service.

Casper supports the following services in the base system:

.Pp

.Bl -tag -width "system.random" -compact -offset indent

.It system.dns

provides DNS libc compatible API

provides libc compatible DNS API

.It system.grp

provides

provides a

.Xr getgrent 3

compatible API

.It system.net

provides network libc compatible API

provides a libc compatible network API

.It system.pwd

provides

provides a

.Xr getpwent 3

compatible API

.It system.sysctl

provides

provides a

.Xr sysctlbyname 3

compatible API

.It system.syslog

provides

provides a

.Xr syslog 3

compatible API

.El

.Sh RETURN VALUES

The

.Fn cap_clone ,

.Fn cap_init ,

.Fn cap_recv_nvlist ,

▲ Show 20 Lines • Show All 59 Lines • Show Last 20 Lines

View Options

sys/dev/bnxt/if_bnxt.c

Show All 22 Lines

.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)

.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT

.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY

.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF

.\" SUCH DAMAGE.

.\"

.\" $FreeBSD$

.\"

.Dd January 3, 2021

.Dd November 15, 2021

.Dt LIBCASPER 3

.Os

.Sh NAME

.Nm cap_init ,

.Nm cap_wrap ,

.Nm cap_unwrap ,

.Nm cap_sock ,

.Nm cap_clone ,

Show All 33 Lines

.Fn cap_recv_nvlist "const cap_channel_t *chan"

.Ft "nvlist_t *"

.Fn cap_xfer_nvlist "const cap_channel_t *chan" "nvlist_t *nvl"

.Ft "cap_channel_t *"

.Fn cap_service_open "const cap_channel_t *chan" "const char *name"

.Sh DESCRIPTION

The

.Nm libcasper

library allows to manage application capabilities through the casper process.

library provides for the control of application capabilities through

the casper process.

oshogboUnsubmitted

Done

This line is longer then 80 lines.

oshogbo: This line is longer then 80 lines.

.Pp

The application capability (represented by the

An application capability, represented by the

.Vt cap_channel_t

type) is a communication channel between the caller and the casper process

type, is a communication channel between the caller and the casper

daemon or an instance of one of its services.

daemon or an instance of one of the daemon's services.

A capability to the casper process obtained with the

A capability to the casper process, obtained with the

.Fn cap_init

function allows to create capabilities to casper's services via the

function, allows a program to create capabilities to access

the casper daemon's services via the

0mpUnsubmitted

Done

acacce looks like a typo

0mp: acacce looks like a typo

.Fn cap_service_open

function.

.Pp

The

.Fn cap_init

function opens capability to the casper process.

function instantiates a capability to allow a program to access

the casper daemon.

.Pp

The

.Fn cap_wrap

function creates

function creates a

.Vt cap_channel_t

based on the given socket.

based on the socket supplied in the call.

The function is used when capability is inherited through

The function is used when a capability is inherited through the

.Xr execve 2

or send over

system call,

or sent over a

.Xr unix 4

domain socket as a regular file descriptor and has to be represented as

domain socket as a file descriptor,

.Vt cap_channel_t

and has to be converted into a

oshogboUnsubmitted

Done

and?

oshogbo: and?

again.

.Vt cap_channel_t .

The

.Fa flags

argument defines the channel behavior.

The supported flags are:

.Bl -ohang -offset indent

.It CASPER_NO_UNIQ

The communication between process and casper uses no unique version of nvlist.

The communication between the process and the casper daemon no

0mpUnsubmitted

Done

The word *uses* disappeared in the process.

0mp: The word *uses* disappeared in the process.

unique version of nvlist.

oshogboUnsubmitted

Done

This line is longer then 80, I'm not sure if this is a bug anymore.

oshogbo: This line is longer then 80, I'm not sure if this is a bug anymore.

.El

.Pp

The

.Fn cap_unwrap

function is the opposite of the

function returns the

oshogboUnsubmitted

Done

The domain socket may or may not be provided in cap_wrap.
The Casper daemon may create a socket using cap_init and you also can obtain this descriptor.
Maybe something like:

The
.Fn cap_unwrap
function returns the
.Xr unix 4
domain socket used by the daemon service,
and frees the
.Vt cap_channel_t
structure.

oshogbo: The domain socket may or may not be provided in cap_wrap. The Casper daemon may create a socket…

.Fn cap_wrap

function.

It frees the

.Vt cap_channel_t

structure and returns

.Xr unix 4

domain socket associated with it.

domain socket used by the daemon service,

and frees the

.Vt cap_channel_t

structure.

.Pp

The

.Fn cap_clone

function clones the given capability.

function returns a clone of the capability passed as its only argument.

.Pp

The

.Fn cap_close

function closes the given capability.

function closes, and frees, the given capability.

.Pp

The

.Fn cap_sock

function returns

function returns the

.Xr unix 4

domain socket descriptor associated with the given capability for use with

system calls like

system calls such as:

.Xr kevent 2 ,

.Xr poll 2

0mpUnsubmitted

Done

.Xr kevent 2 ,

- .Xr poll 2

+ .Xr poll 2 ,

and

.Xr select 2 .

0mp:

and

.Xr select 2 .

.Pp

The

.Fn cap_limit_get

function stores current limits of the given capability in the

function stores the current limits of the given capability in the

.Fa limitsp

argument.

If the function return

If the function returns

.Va 0

and

.Dv NULL

is stored in

is stored in the

.Fa limitsp

it means there are no limits set.

argument,

there are no limits set.

.Pp

The

.Fn cap_limit_set

function sets limits for the given capability.

The limits are provided as a

The limits are provided as an

.Xr nvlist 9 .

The exact format depends on the service the capability represents.

The exact format of the limits depends on the service that the

capability represents.

.Fn cap_limit_set

frees the limits regardless of whether the operation succeeds or fails.

frees the limits passed to the call,

whether or not the operation succeeds or fails.

.Pp

The

.Fn cap_send_nvlist

function sends the given

.Xr nvlist 9

over the given capability.

This is low level interface to communicate with casper services.

This is a low level interface to communicate with casper services.

Most services should provide higher level API.

It is expected that most services will provide a higher level API.

.Pp

The

.Fn cap_recv_nvlist

function receives the given

.Xr nvlist 9

over the given capability.

.Pp

The

.Fn cap_xfer_nvlist

function sends the given

.Xr nvlist 9 ,

destroys it and receives new

destroys it,

and receives a new

oshogboUnsubmitted

Done

I'm not sure what the convention is but in other cases after Oxford Comma you put a new line.

oshogbo: I'm not sure what the convention is but in other cases after Oxford Comma you put a new line.

.Xr nvlist 9

in response over the given capability.

It does not matter if the function succeeds or fails, the

.Xr nvlist 9

given for sending will always be destroyed once the function returns.

given for sending will always be destroyed before the function returns.

.Pp

The

.Fn cap_service_open

function opens casper service of the given name through casper capability

function opens the casper service named in the call using

obtained via the

the casper capability obtained via the

.Fn cap_init

function.

The function returns capability that provides access to opened service.

The

.Fn cap_service_open

function returns a capability that provides access to the opened service.

Casper supports the following services in the base system:

.Pp

.Bl -tag -width "system.random" -compact -offset indent

.It system.dns

provides DNS libc compatible API

provides libc compatible DNS API

.It system.grp

provides

provides a

.Xr getgrent 3

compatible API

.It system.net

provides network libc compatible API

provides a libc compatible network API

.It system.pwd

provides

provides a

.Xr getpwent 3

compatible API

.It system.sysctl

provides

provides a

.Xr sysctlbyname 3

compatible API

.It system.syslog

provides

provides a

.Xr syslog 3

compatible API

.El

.Sh RETURN VALUES

The

.Fn cap_clone ,

.Fn cap_init ,

.Fn cap_recv_nvlist ,

▲ Show 20 Lines • Show All 59 Lines • Show Last 20 Lines

bnxt: Add support for magic packet based Wake-on-LAN.ClosedPublicActions

Details

Diff Detail

Event Timeline

Revision ContentsChangeset List

Diff 27178

sys/dev/bnxt/bnxt.h

sys/dev/bnxt/bnxt_hwrm.h

sys/dev/bnxt/bnxt_hwrm.c

sys/dev/bnxt/if_bnxt.c

bnxt: Add support for magic packet based Wake-on-LAN.
ClosedPublic
Actions

Revision Contents
Changeset List