'\" t
.\"     Title: cxl-set-partition
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.20
.\"      Date: 2024-01-12
.\"    Manual: cxl Manual
.\"    Source: cxl
.\"  Language: English
.\"
.TH "CXL\-SET\-PARTITION" "1" "2024-01-12" "cxl" "cxl Manual"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "NAME"
cxl-set-partition \- set the partitioning between volatile and persistent capacity on a CXL memdev
.SH "SYNOPSIS"
.sp
.nf
\fIcxl set\-partition <mem0> [ [<mem1>..<memN>] [<options>]\fP
.fi
.br
.SH "DESCRIPTION"
.sp
CXL devices may support both volatile and persistent memory capacity.
The amount of device capacity set aside for each type is typically
established at the factory, but some devices also allow for dynamic
re\-partitioning.
.sp
Use this command to partition a device into volatile and persistent
capacity. The change in partitioning becomes the “next” configuration,
to become active on the next device reset.
.sp
Use "cxl list \-m <memdev> \-I" to examine the partitioning capabilities
of a device. A partition_alignment_size value of zero means there is
no available capacity and therefore the partitions cannot be changed.
.sp
Using this command to change the size of the persistent capacity shall
result in the loss of data stored.
.SH "OPTIONS"
.sp
<memory device(s)>
.RS 4
A \fImemX\fP device name, or a memdev id number. Restrict the operation to
the specified memdev(s). The keyword \fIall\fP can be specified to indicate
the lack of any restriction.
.RE
.sp
\-S, \-\-serial
.RS 4
Rather an a memdev id number, interpret the <memdev> argument(s)
as a list of serial numbers.
.RE
.sp
\-b, \-\-bus=
.RS 4
Restrict the operation to the specified bus.
.RE
.sp
\-t, \-\-type=
.RS 4
Type of partition, \fIpmem\fP or \fIram\fP (volatile), to modify.
Default: \fIpmem\fP
.RE
.sp
\-s, \-\-size=
.RS 4
Size of the <type> partition in bytes. Size must align to the
devices alignment requirement. Use \fIcxl list \-m <memdev> \-I\fP
to find \fIpartition_alignment_size\fP, or, use the \-\-align option.
Default: All available capacity is assigned to <type>.
.RE
.sp
\-a, \-\-align
.RS 4
Select this option to allow the automatic alignment of \-\-size
to meet device alignment requirements. When using this option,
specify the minimum \-\-size of the \-\-type partition needed. When
this option is omitted, the command fails if \-\-size is not
properly aligned. Use \fIcxl list \-m <memdev> \-I\fP to examine the
partition_alignment_size.
.RE
.sp
\-v
.RS 4
Turn on verbose debug messages in the library (if libcxl was built with
logging and debug enabled).
.RE
.SH "COPYRIGHT"
.sp
Copyright \(co 2016 \- 2022, Intel Corporation. License GPLv2: GNU GPL
version 2 \c
.URL "http://gnu.org/licenses/gpl.html" "" "."
This is free software:
you are free to change and redistribute it.  There is NO WARRANTY, to
the extent permitted by law.
.SH "SEE ALSO"
.sp
cxl\-list(1),
CXL\-2.0 8.2.9.5.2