Skip to content

Commit aa3e5d0

Browse files
committed
Add documentation note about set and way masking for CBP methods
1 parent 4589661 commit aa3e5d0

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

src/peripheral/mod.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1005,6 +1005,8 @@ impl Cbp {
10051005
}
10061006

10071007
/// D-cache invalidate by set-way
1008+
///
1009+
/// `set` is masked to be between 0 and 3, and `way` between 0 and 511.
10081010
#[inline(always)]
10091011
pub fn dcisw(&self, set: u16, way: u16) {
10101012
// The ARMv7-M Architecture Reference Manual, as of Revision E.b, says these set/way
@@ -1035,6 +1037,8 @@ impl Cbp {
10351037
}
10361038

10371039
/// D-cache clean by set-way
1040+
///
1041+
/// `set` is masked to be between 0 and 3, and `way` between 0 and 511.
10381042
#[inline(always)]
10391043
pub fn dccsw(&self, set: u16, way: u16) {
10401044
// See comment for dcisw() about the format here
@@ -1051,6 +1055,8 @@ impl Cbp {
10511055
}
10521056

10531057
/// D-cache clean and invalidate by set-way
1058+
///
1059+
/// `set` is masked to be between 0 and 3, and `way` between 0 and 511.
10541060
#[inline(always)]
10551061
pub fn dccisw(&self, set: u16, way: u16) {
10561062
// See comment for dcisw() about the format here

0 commit comments

Comments
 (0)