Skip to content

Commit d94e1e0

Browse files
charleskeepaxvinodkoul
authored andcommitted
soundwire: bus: Update kernel doc for no_pm functions
The kernel doc should really have been updated when the no_pm versions of the sdw_write/read functions were exported in commits: commit 167790a ("soundwire: export sdw_write/read_no_pm functions") commit 62dc9f3 ("soundwire: bus: export sdw_nwrite_no_pm and sdw_nread_no_pm functions") Add the missing kernel doc. Signed-off-by: Charles Keepax <ckeepax@opensource.cirrus.com> Link: https://lore.kernel.org/r/20230322164948.566962-2-ckeepax@opensource.cirrus.com Signed-off-by: Vinod Koul <vkoul@kernel.org>
1 parent ff9608c commit d94e1e0

1 file changed

Lines changed: 37 additions & 0 deletions

File tree

drivers/soundwire/bus.c

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -386,6 +386,13 @@ int sdw_fill_msg(struct sdw_msg *msg, struct sdw_slave *slave,
386386
* Read/Write IO functions.
387387
*/
388388

389+
/**
390+
* sdw_nread_no_pm() - Read "n" contiguous SDW Slave registers with no PM
391+
* @slave: SDW Slave
392+
* @addr: Register address
393+
* @count: length
394+
* @val: Buffer for values to be read
395+
*/
389396
int sdw_nread_no_pm(struct sdw_slave *slave, u32 addr, size_t count, u8 *val)
390397
{
391398
struct sdw_msg msg;
@@ -403,6 +410,13 @@ int sdw_nread_no_pm(struct sdw_slave *slave, u32 addr, size_t count, u8 *val)
403410
}
404411
EXPORT_SYMBOL(sdw_nread_no_pm);
405412

413+
/**
414+
* sdw_nwrite_no_pm() - Write "n" contiguous SDW Slave registers with no PM
415+
* @slave: SDW Slave
416+
* @addr: Register address
417+
* @count: length
418+
* @val: Buffer for values to be written
419+
*/
406420
int sdw_nwrite_no_pm(struct sdw_slave *slave, u32 addr, size_t count, const u8 *val)
407421
{
408422
struct sdw_msg msg;
@@ -420,6 +434,12 @@ int sdw_nwrite_no_pm(struct sdw_slave *slave, u32 addr, size_t count, const u8 *
420434
}
421435
EXPORT_SYMBOL(sdw_nwrite_no_pm);
422436

437+
/**
438+
* sdw_write_no_pm() - Write a SDW Slave register with no PM
439+
* @slave: SDW Slave
440+
* @addr: Register address
441+
* @value: Register value
442+
*/
423443
int sdw_write_no_pm(struct sdw_slave *slave, u32 addr, u8 value)
424444
{
425445
return sdw_nwrite_no_pm(slave, addr, 1, &value);
@@ -492,6 +512,11 @@ int sdw_bwrite_no_pm_unlocked(struct sdw_bus *bus, u16 dev_num, u32 addr, u8 val
492512
}
493513
EXPORT_SYMBOL(sdw_bwrite_no_pm_unlocked);
494514

515+
/**
516+
* sdw_read_no_pm() - Read a SDW Slave register with no PM
517+
* @slave: SDW Slave
518+
* @addr: Register address
519+
*/
495520
int sdw_read_no_pm(struct sdw_slave *slave, u32 addr)
496521
{
497522
u8 buf;
@@ -538,6 +563,9 @@ EXPORT_SYMBOL(sdw_update);
538563
* @addr: Register address
539564
* @count: length
540565
* @val: Buffer for values to be read
566+
*
567+
* This version of the function will take a PM reference to the slave
568+
* device.
541569
*/
542570
int sdw_nread(struct sdw_slave *slave, u32 addr, size_t count, u8 *val)
543571
{
@@ -562,6 +590,9 @@ EXPORT_SYMBOL(sdw_nread);
562590
* @addr: Register address
563591
* @count: length
564592
* @val: Buffer for values to be written
593+
*
594+
* This version of the function will take a PM reference to the slave
595+
* device.
565596
*/
566597
int sdw_nwrite(struct sdw_slave *slave, u32 addr, size_t count, const u8 *val)
567598
{
@@ -584,6 +615,9 @@ EXPORT_SYMBOL(sdw_nwrite);
584615
* sdw_read() - Read a SDW Slave register
585616
* @slave: SDW Slave
586617
* @addr: Register address
618+
*
619+
* This version of the function will take a PM reference to the slave
620+
* device.
587621
*/
588622
int sdw_read(struct sdw_slave *slave, u32 addr)
589623
{
@@ -603,6 +637,9 @@ EXPORT_SYMBOL(sdw_read);
603637
* @slave: SDW Slave
604638
* @addr: Register address
605639
* @value: Register value
640+
*
641+
* This version of the function will take a PM reference to the slave
642+
* device.
606643
*/
607644
int sdw_write(struct sdw_slave *slave, u32 addr, u8 value)
608645
{

0 commit comments

Comments
 (0)